object PublicTokenCreatedContainer

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/PublicToken"
    }
  },
  "x-internal": true
}

object RequestBodyToCreatePgoTaskReviewsByIdReviewsContainer

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/PgoTaskReviewsByIdToCreate"
    }
  },
  "x-internal": true
}

object RequestBodyToCreatePgoTaskReviewsReviewsContainer

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/PgoTaskReviewsToCreate"
    }
  },
  "x-internal": true
}

object RequestCustomVerificationLetterContainer

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/LetterRequest"
    }
  },
  "x-internal": true
}

object RequestCustomVerificationLetterWithFile

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/LetterRequest"
    },
    {
      "type": "object",
      "required": [
        "files"
      ],
      "properties": {
        "files": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/FileObject"
          }
        }
      }
    }
  ]
}

object RequesterTimeOff

{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UniqueObjectIdentifier"
    },
    "uuid": {
      "type": "string",
      "example": "8bf2ee9c-aa43-4d8e-9f6f-ee8b880b3607"
    },
    "country": {
      "type": "string",
      "example": "LB"
    },
    "end_date": {
      "type": "string",
      "example": "2023-08-04T09:03:31.577Z"
    },
    "created_at": {
      "type": "string",
      "example": "2023-08-04T09:03:31.577Z"
    },
    "updated_at": {
      "type": "string",
      "example": "2023-08-04T09:03:31.577Z"
    },
    "worker_type": {
      "type": "string",
      "example": "hris_direct_employee"
    },
    "is_part_time": {
      "type": "boolean",
      "example": false
    },
    "hris_profile_id": {
      "type": "string",
      "example": "05ab39e5-1200-4cc1-90bf-0969e02bcf02"
    },
    "organization_id": {
      "type": "number",
      "example": 306415
    },
    "client_profile_id": {
      "type": "string",
      "example": "08462445-3a37-4d3e-8413-bf28a125dabd"
    },
    "has_reached_end_date": {
      "type": "boolean",
      "example": false
    },
    "part_time_percentage": {
      "type": "string",
      "example": ""
    }
  }
}

object ResponseBodyForAdjustmentById

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/PayrollAdjustment"
    }
  },
  "x-internal": true
}

object ResponseEstimateFirstPayment

{
  "type": "object",
  "properties": {
    "pro_rata": {
      "$ref": "#/components/schemas/ProRata"
    },
    "first_payment_dates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FirstPaymentDate"
      }
    }
  },
  "x-internal": true
}

object ResponseEstimateFirstPaymentContainer

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/ResponseEstimateFirstPayment"
    }
  },
  "x-internal": true
}

string SalaryFrequencyScaleEnum

{
  "enum": [
    "monthly",
    "quarterly",
    "annually",
    "specific_month",
    "specific_date"
  ],
  "type": "string",
  "example": "monthly",
  "x-internal": true,
  "description": "Scale of the salary frequency."
}

object SearchRequest

{
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "format": "int32",
      "description": "page size"
    },
    "filter": {
      "type": "string",
      "description": "only support 'userName' or 'email' filter expressions for now"
    },
    "schemas": {
      "type": "array",
      "items": {
        "enum": [
          "urn:ietf:params:scim:api:messages:2.0:SearchRequest"
        ],
        "type": "string"
      }
    },
    "startIndex": {
      "type": "integer",
      "format": "int32",
      "description": "start index (1-based)"
    }
  }
}

object Seniority

{
  "type": "object",
  "nullable": true,
  "required": [
    "id",
    "name"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UniqueObjectIdentifier",
      "description": "Unique identifier for seniority record"
    },
    "name": {
      "type": "string",
      "example": "Mid (Individual Contributor Level 2)",
      "nullable": false,
      "minLength": 1,
      "description": "Name of seniority level e.g. Mid (Individual Contributor Level 2)"
    },
    "level": {
      "type": "number",
      "example": 2,
      "nullable": true,
      "description": "Level of seniority level e.g. 2"
    }
  },
  "x-internal": true,
  "description": "Seniority describes level of expertise at a job e.g. junior"
}

array SeniorityList

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/SeniorityRequired"
  },
  "x-internal": true
}

object SeniorityListContainer

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/SeniorityList"
    }
  },
  "x-internal": true
}

object SeniorityRequired

{
  "type": "object",
  "required": [
    "id",
    "name",
    "level"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UniqueObjectIdentifier",
      "description": "Unique identifier for seniority record."
    },
    "name": {
      "type": "string",
      "example": "Mid (Individual Contributor Level 2)",
      "nullable": false,
      "minLength": 1,
      "description": "Name of seniority level e.g. Mid (Individual Contributor Level 2)"
    },
    "level": {
      "type": "number",
      "example": 2,
      "nullable": false,
      "description": "Level of seniority level e.g. 2"
    }
  },
  "x-internal": true,
  "description": "Seniority describes level of expertise at a job e.g. junior"
}

object ServiceProviderConfig

{
  "type": "object",
  "properties": {
    "bulk": {
      "$ref": "#/components/schemas/BulkSupported"
    },
    "etag": {
      "$ref": "#/components/schemas/Supported"
    },
    "sort": {
      "$ref": "#/components/schemas/Supported"
    },
    "patch": {
      "$ref": "#/components/schemas/Supported"
    },
    "filter": {
      "$ref": "#/components/schemas/FilterSupported"
    },
    "schemas": {
      "type": "array",
      "items": {
        "enum": [
          "urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"
        ],
        "type": "string"
      }
    },
    "xmlDataFormat": {
      "$ref": "#/components/schemas/Supported"
    },
    "changePassword": {
      "$ref": "#/components/schemas/Supported"
    },
    "authenticationSchemes": {
      "$ref": "#/components/schemas/AuthenticationSchemes"
    }
  }
}

object SignaturesOfBasicContract

{
  "type": "object",
  "required": [
    "client_signed_at",
    "worker_signature",
    "worker_signed_at"
  ],
  "properties": {
    "client_signed_at": {
      "$ref": "#/components/schemas/DateTimeString"
    },
    "worker_signature": {
      "type": "string",
      "example": "Jane Doe",
      "nullable": false,
      "description": "Worker's signature."
    },
    "worker_signed_at": {
      "$ref": "#/components/schemas/DateTimeString"
    }
  },
  "x-internal": true
}

object SignaturesOfContract

{
  "type": "object",
  "required": [
    "client_signature",
    "client_signed_at",
    "worker_signature",
    "worker_signed_at",
    "signed_at"
  ],
  "properties": {
    "signed_at": {
      "$ref": "#/components/schemas/DateTimeString"
    },
    "client_signature": {
      "type": "string",
      "description": "normally name of client is used as signature"
    },
    "client_signed_at": {
      "$ref": "#/components/schemas/DateTimeString"
    },
    "worker_signature": {
      "type": "string",
      "nullable": false,
      "description": "Signatures of client representative."
    },
    "worker_signed_at": {
      "$ref": "#/components/schemas/DateTimeString"
    }
  },
  "x-internal": true
}

string SortDirEnum

{
  "enum": [
    "asc",
    "desc"
  ],
  "type": "string",
  "x-internal": true
}

object StateOfCountry

{
  "type": "object",
  "required": [
    "code",
    "name"
  ],
  "properties": {
    "code": {
      "type": "string",
      "example": "NY",
      "nullable": false,
      "minLength": 1,
      "description": "Territory code."
    },
    "name": {
      "type": "string",
      "example": "New York",
      "nullable": false,
      "minLength": 1,
      "description": "Territory name."
    }
  },
  "x-internal": true,
  "description": "It may be called states, provinces, prefectures or regions, or none at all"
}

object Supported

{
  "type": "object",
  "properties": {
    "supported": {
      "type": "boolean",
      "default": false
    }
  }
}

object TaskCreated

{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UniqueObjectIdentifier"
    },
    "status": {
      "$ref": "#/components/schemas/TimesheetStatusEnum"
    },
    "created": {
      "type": "boolean",
      "description": "Whether the creation operation was successful."
    }
  },
  "x-internal": true
}

object TaskCreatedContainer

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/TaskCreated"
    }
  },
  "x-internal": true
}

array TaskList

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/PgoTask"
  },
  "x-internal": true
}

object TaskListContainer

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/TaskList"
    }
  },
  "x-internal": true
}

object Team

{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UniqueObjectIdentifier",
      "description": "The unique identifier for the team."
    },
    "name": {
      "type": "string",
      "description": "The name of the team."
    }
  }
}

array TeamList

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/BasicTeam"
  },
  "x-internal": true
}

object TeamListContainer

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/TeamList"
    }
  },
  "x-internal": true
}

object TeamOfBasicContract

{
  "type": "object",
  "required": [
    "id",
    "name"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UniqueObjectIdentifier",
      "description": "Unique reference of a team"
    },
    "name": {
      "type": "string",
      "nullable": true,
      "description": "Name of a team"
    }
  },
  "x-internal": true
}

object TeamOfContract

{
  "type": "object",
  "required": [
    "id",
    "name"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UniqueObjectIdentifier",
      "description": "Unique reference of a team"
    },
    "name": {
      "type": "string",
      "nullable": false,
      "description": "Name of a team"
    }
  },
  "x-internal": true
}

object TimeoffReview

{
  "type": "object",
  "required": [
    "is_approved"
  ],
  "properties": {
    "is_approved": {
      "type": "boolean",
      "example": true,
      "description": "Approve or decline employee's time off request."
    },
    "denial_reason": {
      "type": "string",
      "example": "Not allowed for this day.",
      "description": "Denial reason for the time off requested."
    }
  }
}

object TimeoffReviewInternal

{
  "type": "object",
  "required": [
    "recipientId",
    "status"
  ],
  "properties": {
    "reason": {
      "type": "string",
      "example": "Approved because there are no conflicts.",
      "description": "The reason that the chosen status was chosen."
    },
    "status": {
      "enum": [
        "APPROVED",
        "REJECTED"
      ],
      "type": "string",
      "example": "APPROVED",
      "description": "The review decision to review the time off request with"
    }
  }
}

object TimeoffToReviewContainer

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/TimeoffReview"
    }
  },
  "x-internal": true
}

object TimeoffToReviewInternalContainer

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/TimeoffReviewInternal"
    }
  },
  "x-internal": true
}

array TimeoffTypeList

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "example": [
    "VACATION",
    "SICK_LEAVE",
    "OTHER"
  ]
}

object TimeoffTypeListContainer

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/TimeoffTypeList"
    }
  },
  "x-internal": true
}

array TimeoffsAttachments

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/TimeoffsAttachmentsItem"
  },
  "description": "A list of attachments. 2022-09-08 FE only allows for \"SICK LEAVE\""
}

object TimeoffsAttachmentsItem

{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UniqueObjectIdentifier"
    },
    "label": {
      "type": "string",
      "description": "The file name"
    },
    "file_extension": {
      "type": "string",
      "description": "The file name extension"
    }
  },
  "description": "A item in attachments array. 2022-09-08 FE only allows for \"SICK LEAVE\""
}

object TimeoffsProfile

{
  "type": "object",
  "required": [
    "id",
    "name",
    "profile_type"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UniqueObjectIdentifier"
    },
    "name": {
      "type": "string",
      "example": "Mr. Rogers"
    },
    "pic_url": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UrlType"
        }
      ],
      "example": "https://media.letsdeel.com/avatar/2ROng8m5?q=1648722955603",
      "nullable": true,
      "description": "Avatar or selfie."
    },
    "is_employee": {
      "type": "boolean",
      "description": "Only valid for requester. True if requester is an employee."
    },
    "profile_type": {
      "$ref": "#/components/schemas/ProfileTypeEnum"
    }
  },
  "x-konfig-properties": {
    "profile_type": {
      "example": "employee"
    }
  }
}

string TimeoffsStatusEnum

{
  "enum": [
    "REQUESTED",
    "APPROVED",
    "REJECTED"
  ],
  "type": "string"
}

string TimeoffsTypeEnum

{
  "enum": [
    "VACATION",
    "SICK_LEAVE",
    "OTHER"
  ],
  "type": "string"
}

object Timesheet

{
  "allOf": [
    {
      "$ref": "#/components/schemas/BasicTimesheet"
    },
    {
      "$ref": "#/components/schemas/TimesheetApproversContainer"
    }
  ],
  "x-internal": true
}

array TimesheetAccountingRefs

{
  "type": "array",
  "items": {
    "type": "object",
    "nullable": false,
    "required": [
      "integration"
    ],
    "properties": {
      "integration": {
        "type": "string",
        "nullable": false
      },
      "mapping_category": {
        "type": "object",
        "required": [
          "id",
          "name"
        ],
        "properties": {
          "id": {
            "type": "string",
            "nullable": false
          },
          "name": {
            "type": "string",
            "nullable": false
          }
        }
      }
    }
  },
  "nullable": true,
  "x-internal": true
}

object TimesheetApprover

{
  "type": "object",
  "required": [
    "full_name",
    "email",
    "approved"
  ],
  "properties": {
    "email": {
      "type": "string"
    },
    "approved": {
      "type": "boolean"
    },
    "full_name": {
      "type": "string"
    }
  },
  "x-internal": true
}

array TimesheetApproverList

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/TimesheetApprover"
  },
  "x-internal": true
}

object TimesheetApproversContainer

{
  "type": "object",
  "required": [
    "approvers"
  ],
  "properties": {
    "approvers": {
      "$ref": "#/components/schemas/TimesheetApproverList"
    }
  },
  "x-internal": true
}

object TimesheetContainer

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/Timesheet"
    }
  },
  "x-internal": true
}

array TimesheetIdItems

{
  "type": "array",
  "items": {
    "oneOf": [
      {
        "type": "number"
      },
      {
        "type": "string"
      }
    ],
    "description": "ID of an existing timesheet record"
  },
  "maxItems": 1000,
  "minItems": 1,
  "nullable": false,
  "x-internal": true
}

array TimesheetList

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/BasicTimesheet"
  },
  "x-internal": true
}

object TimesheetListContainer

{
  "type": "object",
  "required": [
    "data",
    "page"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/TimesheetList"
    },
    "page": {
      "$ref": "#/components/schemas/PageInfoWithoutCursor"
    }
  },
  "x-internal": true
}