Paychex · Schema

Paychex Company

A Paychex Flex company (employer) that a registered application can act on.

BenefitsHCMHRPaychex FlexPayrollTime and AttendanceWorkforceFortune 1000

Properties

Name Type Description
companyId string Paychex Flex company identifier.
displayId string Human-readable display identifier shown in Paychex Flex.
legalName string Legal business name of the company.
dba string Doing-business-as name.
federalEin string Federal Employer Identification Number (EIN).
status string Company status (e.g., ACTIVE, INACTIVE).
clientType string Paychex client product line (e.g., Flex, PEO, SurePayroll).
View JSON Schema on GitHub

JSON Schema

paychex-companies-company-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/paychex-developer/main/json-schema/paychex-companies-company-schema.json",
  "title": "Paychex Company",
  "description": "A Paychex Flex company (employer) that a registered application can act on.",
  "type": "object",
  "properties": {
    "companyId": {
      "type": "string",
      "description": "Paychex Flex company identifier."
    },
    "displayId": {
      "type": "string",
      "description": "Human-readable display identifier shown in Paychex Flex."
    },
    "legalName": {
      "type": "string",
      "description": "Legal business name of the company."
    },
    "dba": {
      "type": "string",
      "description": "Doing-business-as name."
    },
    "federalEin": {
      "type": "string",
      "description": "Federal Employer Identification Number (EIN)."
    },
    "status": {
      "type": "string",
      "description": "Company status (e.g., ACTIVE, INACTIVE)."
    },
    "clientType": {
      "type": "string",
      "description": "Paychex client product line (e.g., Flex, PEO, SurePayroll)."
    }
  },
  "required": ["companyId"]
}