OrganizationList
{
"type": "array",
"items": {
"$ref": "#/components/schemas/BasicOrganization"
},
"x-internal": true
}
OrganizationListContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/OrganizationList"
}
},
"x-internal": true
}
OutputToCreateFileRef
{
"type": "object",
"required": [
"key",
"url"
],
"properties": {
"key": {
"type": "string",
"nullable": false
},
"url": {
"type": "string",
"nullable": false
}
},
"x-internal": true
}
OutputToCreateFileRefContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/OutputToCreateFileRef"
}
},
"x-internal": true
}
PageInfo
{
"type": "object",
"required": [
"cursor",
"total_rows"
],
"properties": {
"cursor": {
"type": "string",
"nullable": false
},
"total_rows": {
"type": "number",
"nullable": false
}
},
"x-internal": true
}
PageInfoWithCursorNew
{
"type": "object",
"required": [
"total_rows",
"items_per_page",
"offset"
],
"properties": {
"cursor": {
"type": "string",
"example": "eyJvZmZzZXQiOjEwMCwibGltaXQiOjEwMCwiZmlsdGVyVHlwZSI6ImFsbCJ9",
"description": "Use for pagination to get next set of records after the given cursor."
},
"offset": {
"type": "number",
"maximum": 999999999,
"minimum": 0,
"nullable": false
},
"total_rows": {
"type": "number",
"nullable": false
},
"items_per_page": {
"type": "number",
"maximum": 99,
"minimum": 1,
"nullable": false
}
},
"x-internal": true
}
PageInfoWithoutCursor
{
"type": "object",
"required": [
"total_rows"
],
"properties": {
"total_rows": {
"type": "number",
"nullable": false
}
},
"x-internal": true
}
PageInfoWithoutCursorNew
{
"type": "object",
"required": [
"total_rows",
"items_per_page",
"offset"
],
"properties": {
"offset": {
"type": "number",
"maximum": 999999999,
"minimum": 0,
"nullable": false
},
"total_rows": {
"type": "number",
"nullable": false
},
"items_per_page": {
"type": "number",
"maximum": 99,
"minimum": 1,
"nullable": false
}
},
"x-internal": true
}
PatchOperation
{
"type": "object",
"required": [
"op"
],
"properties": {
"op": {
"enum": [
"add",
"replace",
"remove"
],
"type": "string"
},
"path": {
"type": "string"
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {}
}
],
"description": "corresponding 'value' of that field specified by 'path'"
}
}
}
PatchWebhookRequest
{
"type": "object",
"required": [
"name",
"description",
"status",
"url",
"signing_key",
"events"
],
"properties": {
"url": {
"type": "string",
"example": "https://mywebhook.com/listening",
"description": "Endpoint to receive webhook."
},
"name": {
"type": "string",
"example": "Demo webhook",
"nullable": true,
"description": "Webhook subscription name."
},
"events": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"contract.created"
],
"description": "The list of events to enable for this subscription."
},
"status": {
"enum": [
"enabled",
"disabled"
],
"type": "string",
"example": "enabled",
"description": "Status of webhook."
},
"api_version": {
"type": "string",
"default": "v2",
"example": "v2",
"nullable": false,
"description": "Deel API version. Currently Deel accepts v1 or v2 version."
},
"description": {
"type": "string",
"example": "My first webhook",
"nullable": true,
"description": "Webhook subscription description."
},
"signing_key": {
"type": "string",
"example": null,
"nullable": true,
"description": "The webhook's signing key, used to generate webhook signatures."
}
}
}
Payment
{
"type": "object",
"required": [
"id",
"payment_method",
"status",
"payment_currency",
"label",
"paid_at",
"created_at",
"total",
"workers"
],
"properties": {
"id": {
"type": "number",
"example": 12345,
"nullable": false,
"description": "Unique identifier of the payment."
},
"label": {
"type": "string"
},
"total": {
"type": "string",
"example": 1015,
"description": "Total paid."
},
"status": {
"$ref": "#/components/schemas/PaymentStatusEnum"
},
"paid_at": {
"$ref": "#/components/schemas/DateTimeString"
},
"workers": {
"$ref": "#/components/schemas/PaymentWorkerList"
},
"created_at": {
"$ref": "#/components/schemas/DateTimeString"
},
"payment_method": {
"$ref": "#/components/schemas/PaymentMethod"
},
"payment_currency": {
"$ref": "#/components/schemas/CurrencyCode"
}
},
"x-konfig-properties": {
"paid_at": {
"example": "2022-08-25T12:09:34.695Z",
"description": "Timestamp when payment was paid."
},
"created_at": {
"example": "2022-08-25T12:09:34.695Z",
"description": "Timestamp when the record was created."
}
}
}
PaymentBreakDown
{
"type": "object",
"nullable": false,
"properties": {
"date": {
"type": "string",
"example": "2022-10-01T00:59:28.482Z"
},
"team": {
"type": "string",
"example": "Deel Inc."
},
"work": {
"type": "string",
"example": "0.00"
},
"bonus": {
"type": "string",
"example": "0.00"
},
"total": {
"type": "string",
"example": "1000.00",
"description": "Total due."
},
"others": {
"type": "string",
"example": "0.00"
},
"currency": {
"type": "string",
"example": "USD",
"description": "Currency code."
},
"expenses": {
"type": "string",
"example": "0.00"
},
"overtime": {
"type": "string",
"example": "0.00"
},
"pro_rata": {
"type": "string",
"example": "0.00"
},
"approvers": {
"type": "string"
},
"frequency": {
"type": "string",
"example": ""
},
"adjustment": {
"type": "string",
"example": "0.00"
},
"deductions": {
"type": "string",
"example": "0.00"
},
"commissions": {
"type": "string",
"example": "0.00"
},
"approve_date": {
"type": "string"
},
"payment_date": {
"type": "string",
"example": "2022-11-01T17:20:32.837Z",
"description": "Date of payment."
},
"invoice_number": {
"type": "string",
"example": "5069872",
"description": "Invoice number."
},
"processing_fee": {
"type": "string",
"example": "0.00"
},
"receipt_number": {
"type": "string",
"example": "5551621"
},
"contract_country": {
"type": "string",
"example": "US",
"description": "Country of the contract."
},
"contractor_email": {
"type": "string",
"example": "name@email.com",
"description": "Worker's email."
},
"payment_currency": {
"type": "string",
"example": "USD"
},
"contract_start_date": {
"type": "string",
"example": "2020-03-31T10:58:49.780Z",
"description": "Contract start date."
},
"general_ledger_account": {
"type": "string",
"example": ""
},
"total_payment_currency": {
"type": "string",
"example": "1000.00",
"description": "Total in payment currency."
},
"contractor_employee_name": {
"type": "string",
"example": "Jane Doe",
"description": "Worker's name."
},
"contractor_unique_identifier": {
"type": "string",
"example": "12345",
"description": "Worker's unique identifier."
}
}
}
PaymentBreakDownContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentBreakDown"
}
}
}
}
PaymentList
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Payment"
}
}
PaymentListContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/PaymentObject"
}
},
"x-internal": true
}
PaymentMethod
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"$ref": "#/components/schemas/PaymentMethodEnum"
}
}
}
PaymentMethodEnum
{
"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"
],
"type": "string",
"nullable": false,
"description": "All the supported payment types"
}
PaymentMethodEnumList
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentMethodEnum"
},
"description": "filter invoices by payment method"
}
PaymentObject
{
"type": "object",
"properties": {
"rows": {
"$ref": "#/components/schemas/PaymentList"
},
"total": {
"type": "number",
"nullable": false
}
}
}
PaymentStatementInitiatedWebhook
{
"type": "object",
"required": [
"billing_invoices",
"invoices"
],
"properties": {
"invoices": {
"type": "array",
"items": {
"type": "number"
}
},
"billing_invoices": {
"type": "array",
"items": {
"type": "number"
}
}
}
}
PaymentStatusEnum
{
"enum": [
"paid",
"processing"
],
"type": "string",
"description": "status of payment"
}
PaymentStatusEnumList
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentStatusEnum"
}
}
PaymentWorker
{
"type": "object",
"title": "The worker for the payment",
"required": [
"name",
"picUrl"
],
"properties": {
"id": {
"type": "number",
"example": 123456,
"description": "Worker's unique id."
},
"name": {
"type": "string",
"default": "",
"example": "Jane Doe",
"description": "Worker's full name."
},
"picUrl": {
"type": "string",
"default": null,
"nullable": true,
"description": "URL to worker's Deel avatar."
},
"contract_id": {
"type": "string",
"nullable": true,
"description": "The worker's Deel contract Id."
}
}
}
PaymentWorkerList
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentWorker"
}
}
PayrollAdjustment
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426614174000",
"description": "The unique identifier of the adjustment"
},
"file": {
"type": "object",
"nullable": true,
"properties": {
"id": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426614174000",
"description": "The unique identifier of the file"
},
"name": {
"type": "string",
"example": "your_file_name",
"description": "The name of the file"
},
"fileType": {
"type": "string",
"example": "pdf",
"description": "The type of the file"
}
}
},
"title": {
"type": "string",
"example": "Your title here",
"description": "The title of the adjustment"
},
"amount": {
"type": "string",
"example": "1234.56",
"description": "The amount of the adjustment"
},
"status": {
"$ref": "#/components/schemas/AdjustmentStatusEnum",
"example": "open",
"description": "The status of the adjustment"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2020-11-02T12:00:00.000Z",
"description": "The date and time when the adjustment was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2020-11-02T12:00:00.000Z",
"description": "The date and time when the adjustment was last updated"
},
"contract_id": {
"type": "string",
"example": "m3jk2j",
"description": "The identifier of the contract associated with the adjustment"
},
"description": {
"type": "string",
"example": "Your description here",
"description": "The description of the adjustment"
},
"cycle_reference": {
"type": "string",
"example": "your_cycle_reference",
"nullable": true,
"description": "The reference to the cycle associated with the adjustment"
},
"move_next_cycle": {
"type": "boolean",
"example": true,
"description": "If an adjustments can belong to another payroll cycle"
},
"date_of_adjustment": {
"type": "string",
"format": "date",
"example": "2023-11-02T00:00:00.000Z",
"description": "The date of the adjustment"
},
"actual_end_cycle_date": {
"type": "string",
"example": "2023-11-15T00:00:00.000Z",
"description": "The date of the actual end cycle date"
},
"adjustment_category_id": {
"type": "string",
"example": "c9cf4c2c0165f48f494415390c3b49",
"description": "The identifier of the adjustment category associated with the adjustment"
},
"actual_start_cycle_date": {
"type": "string",
"example": "2023-11-01T00:00:00.000Z",
"description": "The date of the actual start cycle date"
}
}
}
PayslipDownloadUrl
{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"example": "https://s3.eu-west-1.amazonaws.com/api-dev-eks.letsdeel.com/employee_payslips/ApdZbLvq0r0E_Payslip_Kulvear_Bowie_2023-12-31.pdf?AWSAccessKeyId=ASIATHF2L5PZ545TTFF7&Expires=1698149134&Signature=DmqwQiXY%2FHmPS%2FYBcB2DOZ9SDVA%3D&x-amz-security-token=zxc"
}
}
}
Payslips
{
"type": "object",
"required": [
"id",
"from",
"to",
"status"
],
"properties": {
"id": {
"type": "string",
"example": "9K1rw5vwkZX2",
"description": "Unique identifier for the payslip."
},
"to": {
"format": "date-time",
"example": "2023-08-31T00:00:00.000Z",
"description": "End date of the payslip."
},
"from": {
"format": "date-time",
"example": "2023-08-01T00:00:00.000Z",
"description": "Start date of the payslip."
},
"status": {
"type": "string",
"example": "PUBLISHED",
"description": "Status of the payslip."
}
},
"x-internal": true
}
PensionEORContractToCreate
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Pension provider id. You can see available pension providers in the country guide endpoint."
},
"contribution": {
"type": "string",
"description": "Enter the value of pension contribution. You should send this value only if the contribution object is available in the country guide endpoint and the value should be there between minimum and maximum values indicated."
}
},
"description": "Some countries required a pension benefit."
}
PensionProvider
{
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/UniqueObjectIdentifier",
"description": "Unique identifier of a Pension provider."
},
"name": {
"type": "string",
"example": "US Pension",
"description": "Name of pension provider."
},
"contribution": {
"$ref": "#/components/schemas/Contribution",
"description": "If it is there, you must specify the contribution property when creating an EOR contract."
},
"home_page_url": {
"type": "string",
"example": "https://bit.ly/3uW72fp",
"description": "Pension provider's home page url."
}
},
"description": "Pension provider."
}
PeopleByIdContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/Employee"
},
{
"type": "object",
"properties": {
"custom_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PeopleCustomField"
}
}
}
}
]
}
}
}
PeopleClientLegalEntity
{
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/UniqueObjectIdentifier",
"description": "The unique identifier for the client legal entity."
},
"name": {
"type": "string",
"description": "The name of the client legal entity."
}
}
}
PeopleContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Employee"
}
},
"page": {
"$ref": "#/components/schemas/PageInfoWithoutCursorNew"
}
}
}
PeopleCustomField
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Job title",
"nullable": false,
"description": "Custom field property name."
},
"value": {
"type": "string",
"example": "Software Engineer II",
"nullable": false,
"description": "Custom field property value."
}
},
"description": "Customized attributes on people (Job title, Project code, etc)."
}
PeopleMe
{
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "Unique identifier for the user profile"
},
"email": {
"type": "string",
"description": "Email address of the user"
},
"user_id": {
"type": "number",
"description": "Unique identifier for the user"
},
"username": {
"type": "string",
"description": "Username of the user"
},
"full_name": {
"type": "string",
"description": "Full name of the user"
},
"last_name": {
"type": "string",
"description": "Last name of the user"
},
"avatar_url": {
"type": "string",
"nullable": true,
"description": "URL of the user's avatar"
},
"first_name": {
"type": "string",
"description": "First name of the user"
},
"middle_name": {
"type": "string",
"nullable": true,
"description": "Middle name of the user"
},
"hris_enabled": {
"type": "boolean",
"nullable": true,
"description": "HRIS feature enabled."
},
"profile_type": {
"$ref": "#/components/schemas/ProfileTypeEnum"
},
"slack_team_id": {
"type": "string",
"nullable": true,
"description": "User's team slack id"
},
"slack_user_id": {
"type": "string",
"nullable": true,
"description": "User's slack id"
},
"client_country": {
"$ref": "#/components/schemas/CountryCodeNulleable"
},
"organization_id": {
"type": "number",
"description": "Unique identifier for the organization"
},
"organization_name": {
"type": "string",
"nullable": true,
"description": "Name of the organization"
},
"contractor_country": {
"$ref": "#/components/schemas/CountryCodeNulleable"
}
},
"description": "People object representing a Deel",
"x-konfig-properties": {}
}
PeoplePayment
{
"type": "object",
"properties": {
"rate": {
"type": "number",
"description": "The payment rate"
},
"scale": {
"type": "string",
"description": "The payment scale (e.g., hourly, weekly, monthly, etc.)"
},
"currency": {
"type": "string",
"description": "The currency code (ISO 4217) for the payment"
},
"contract_name": {
"type": "string",
"description": "The name of the contract associated with the payment"
}
}
}
PeopleSortByEnum
{
"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"
],
"type": "string",
"x-internal": true
}
PeopleTimeOffContainer
{
"type": "object",
"properties": {
"type": {
"enum": [
"VACATION",
"SICK_LEAVE",
"OTHER"
],
"type": "string",
"example": "VACATION",
"description": "Time off type."
},
"reason": {
"type": "string",
"example": "Holiday",
"description": "Description for employee's time off."
},
"end_date": {
"type": "string",
"example": "2022-09-05T00:00:00.000Z",
"description": "End date of employee's time off."
},
"start_date": {
"type": "string",
"example": "2022-09-03T00:00:00.000Z",
"description": "Start date of employee's time off."
},
"attachments": {
"type": "string",
"format": "binary",
"description": "Attachments for employee's time off."
}
}
}
PgoTask
{
"type": "object",
"required": [
"id",
"amount",
"date_submitted",
"description",
"status"
],
"properties": {
"id": {
"$ref": "#/components/schemas/UniqueObjectIdentifier",
"description": "Unique identifier of the task."
},
"amount": {
"type": "string",
"example": "200",
"nullable": false,
"description": "Fixed rate for this task."
},
"status": {
"$ref": "#/components/schemas/TimesheetStatusEnum"
},
"attachment": {
"$ref": "#/components/schemas/FileAttachmentInfo"
},
"description": {
"type": "string",
"example": "Make the button pop.",
"nullable": false,
"description": "Task description."
},
"date_submitted": {
"$ref": "#/components/schemas/DateStringRequired"
}
},
"x-internal": true
}
PgoTaskReviewsByIdToCreate
{
"type": "object",
"required": [
"status"
],
"properties": {
"reason": {
"type": "string",
"example": "Excited!",
"nullable": true,
"description": "Review comments."
},
"status": {
"enum": [
"approved",
"declined"
],
"type": "string",
"example": "approved",
"nullable": false,
"description": "Review status."
}
},
"x-internal": true
}
PgoTaskReviewsToCreate
{
"type": "object",
"required": [
"status",
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UniqueObjectIdentifier",
"description": "ID of an existing timesheet record"
},
"example": [
1234,
1235
],
"maxItems": 1000,
"minItems": 1
},
"reason": {
"type": "string",
"example": "Great work.",
"nullable": true,
"description": "Additional comments with the reivew."
},
"status": {
"enum": [
"approved",
"declined"
],
"type": "string",
"example": "approved",
"nullable": false,
"description": "Review status."
}
},
"x-internal": true
}
PgoTaskToCreate
{
"type": "object",
"required": [
"amount",
"date_submitted",
"description"
],
"properties": {
"amount": {
"type": "string",
"example": "123.45",
"nullable": false,
"minLength": 1,
"description": "Fixed rate for this task."
},
"attachment": {
"$ref": "#/components/schemas/FileAttachmentInfo"
},
"description": {
"type": "string",
"example": "Make the button pop.",
"nullable": true,
"description": "Task description."
},
"date_submitted": {
"$ref": "#/components/schemas/DateStringRequired"
}
},
"x-internal": true
}
PgoTaskToDelete
{
"type": "object",
"properties": {
"description": {
"type": "string",
"nullable": true,
"description": "Description of exclusion."
},
"delete_recurring_report": {
"type": "boolean",
"nullable": true,
"description": "Request to delete recurring report."
}
},
"x-internal": true
}
PremiumResultAdded
{
"type": "object",
"required": [
"id",
"calculated_premium",
"misclassification_guarantee",
"penalties",
"third_party_liabilities"
],
"properties": {
"id": {
"type": "string",
"example": "d3f79ad9-b0b5-4e0d-af2e-ad84435c0acb",
"nullable": false,
"description": "Deel Premium plan id."
},
"penalties": {
"type": "object",
"nullable": false,
"properties": {
"name": {
"type": "string",
"nullable": false,
"description": "Penalties."
},
"description": {
"type": "string",
"nullable": false,
"description": "Get indemnity against tax authority penalties, liabilities and fines."
}
}
},
"calculated_premium": {
"type": "number",
"example": 50,
"nullable": false,
"description": "Cost for Deel Premium."
},
"third_party_liabilities": {
"type": "object",
"nullable": false,
"properties": {
"name": {
"type": "string",
"nullable": false,
"description": "Third-party liabilities."
},
"description": {
"type": "string",
"nullable": false,
"description": "Get indemnity against third parties up to $10k depending on the court's decision."
}
}
},
"misclassification_guarantee": {
"type": "object",
"nullable": false,
"properties": {
"name": {
"type": "string",
"nullable": false,
"description": "Legal costs."
},
"description": {
"type": "string",
"nullable": false,
"description": "Cover your legal defense costs."
}
}
}
},
"x-internal": true
}
PremiumResultAddedContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/PremiumResultAdded"
}
},
"x-internal": true
}
PremiumToAdd
{
"type": "object",
"nullable": false,
"required": [
"agreement_reflects_relation",
"contractor_characteristics"
],
"properties": {
"contractor_characteristics": {
"enum": [
true,
false
],
"type": "boolean",
"example": false,
"nullable": false,
"description": "Workers doing certain jobs may be considered to be employees by law, even if they would otherwise be considered independent contractors under common law. Is the work of this worker characterized as: Apprentice, Trainee, Labourer, Driver, Medical worker, Legal worker, Construction worker or someone working in the fields of Finance/Investment?"
},
"agreement_reflects_relation": {
"enum": [
true,
false
],
"type": "boolean",
"example": true,
"nullable": false,
"description": "Is the Contractor Agreement selected on the Deel Platform perfectly reflecting your organizations relation and actual working practices with the contractor?"
}
},
"x-internal": true
}
PremiumToAddContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/PremiumToAdd"
}
},
"x-internal": true
}
ProRata
{
"type": "object",
"nullable": false,
"properties": {
"rate": {
"type": "number",
"example": 2500,
"minimum": 0,
"nullable": false,
"description": "Rate to be paid."
},
"total": {
"type": "number",
"example": 2500,
"minimum": 0,
"nullable": false,
"description": "Total to be paid."
},
"cycle_end": {
"$ref": "#/components/schemas/DateStringRequired"
},
"daily_rate": {
"type": "number",
"example": 2500,
"minimum": 0,
"nullable": false,
"description": "Daily rate to be paid."
},
"cycle_start": {
"$ref": "#/components/schemas/DateStringRequired"
},
"work_week_end": {
"$ref": "#/components/schemas/WeekDaysEnum"
},
"cycle_work_days": {
"type": "number",
"example": 11,
"minimum": 0,
"nullable": false,
"description": "Total days to be work."
},
"work_week_start": {
"$ref": "#/components/schemas/WeekDaysEnum"
},
"calculation_type": {
"enum": [
"CUSTOM_AMOUNT",
"WORK_DAYS",
"CALENDAR_DAYS",
"FULL_AMOUNT"
],
"type": "string",
"nullable": false,
"description": "Either works days or calendar days"
}
},
"x-internal": true,
"description": "Details of the pro rata for the first payment"
}
ProfileTypeEnum
{
"enum": [
"client",
"contractor",
"icp",
"direct_employee",
"hris_direct_employee",
"service_account"
],
"type": "string",
"x-internal": true
}
PublicId
{
"type": "string",
"format": "uuid",
"example": "00000000-0000-0000-0000-000000000000",
"nullable": true,
"description": "The public UUID of the object"
}
PublicToken
{
"type": "object",
"required": [
"token"
],
"properties": {
"token": {
"type": "string",
"example": "eXampL3.t0Ken",
"description": "Public token."
}
}
}