Pinwheel · Schema

CompanyEmploymentObjResponse

PayrollDirect DepositIncome VerificationEmploymentTax FormsFintechOpen FinanceBill SwitchingFinancial Data

Properties

Name	Type	Description
created_at	string	ISO 8601 timestamp of created time.
employee_external_id	string	Employee ID as reported by their employer.
status	object	The employment status of the employee.
employment_type	object	The employment type e.g. full time, part time, seasonal, contractor.
start_date	string	The date the employee began their job.
termination_date	string	The date the employee was terminated.
employer_name	string	Name of employer, e.g., Apple, Disney, Walmart.
title	string	The job title of the employee.
department	string	The department the employee works in.
manager_external_id	string	The employee's manager's employee ID.
class_code	string	A three- to four-digit code that identifies types of work, typically used by insurance companies to evaluate risk.
employer_address	object	The address of the employer.

View JSON Schema on GitHub

JSON Schema

{
  "properties": {
    "created_at": {
      "type": "string",
      "format": "date-time",
      "title": "created_at",
      "description": "ISO 8601 timestamp of created time."
    },
    "employee_external_id": {
      "type": "string",
      "title": "employee_external_id",
      "description": "Employee ID as reported by their employer."
    },
    "status": {
      "allOf": [
        {
          "type": "string",
          "enum": [
            "employed",
            "terminated",
            "furloughed"
          ]
        }
      ],
      "description": "The employment status of the employee."
    },
    "employment_type": {
      "allOf": [
        {
          "type": "string",
          "enum": [
            "full_time",
            "part_time",
            "seasonal",
            "temporary",
            "contractor",
            "self_employed",
            "per_diem",
            "commission"
          ]
        }
      ],
      "description": "The employment type e.g. full time, part time, seasonal, contractor."
    },
    "start_date": {
      "type": "string",
      "format": "date",
      "title": "start_date",
      "description": "The date the employee began their job."
    },
    "termination_date": {
      "type": "string",
      "format": "date",
      "title": "termination_date",
      "description": "The date the employee was terminated."
    },
    "employer_name": {
      "type": "string",
      "title": "employer_name",
      "description": "Name of employer, e.g., Apple, Disney, Walmart."
    },
    "title": {
      "type": "string",
      "title": "title",
      "description": "The job title of the employee."
    },
    "department": {
      "type": "string",
      "title": "department",
      "description": "The department the employee works in."
    },
    "manager_external_id": {
      "type": "string",
      "title": "manager_external_id",
      "description": "The employee's manager's employee ID."
    },
    "class_code": {
      "type": "string",
      "title": "class_code",
      "description": "A three- to four-digit code that identifies types of work, typically used by insurance companies to evaluate risk."
    },
    "employer_address": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AddressGetResponseItem"
        }
      ],
      "title": "employer_address",
      "description": "The address of the employer."
    }
  },
  "type": "object",
  "required": [
    "created_at",
    "employee_external_id",
    "employer_name"
  ],
  "title": "CompanyEmploymentObjResponse",
  "x-tags": [
    "Schemas"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schema.pinwheelapi.com/CompanyEmploymentObjResponse.json"
}