Company

Companies

Array of companies that your application has been granted with some level of access. Your Application (API Key) can be granted access to one or more companies (clients) accounts that are associated with one or more product lines within Paychex.

get/companies

Request

Base URL
https://api.paychex.com
Auth
none declared
TypeScript
https://skmtc.dev/paychex/apis/external-api/docs/companies/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

displayidstring

The client account number used for identification purposes. (no dash or spaces allowed, only the last 8 characters of the ID)

Response

successful operation

Example response

{
  "content": {
    "companyId": "99Z5V9BTI8J2FCGESC05",
    "displayId": "09620579",
    "legalName": "Monsters, Inc",
    "communications": [
      {
        "communicationId": "00Z5V9BTINBT97UMERCA",
        "type": "STREET_ADDRESS",
        "usageType": "BUSINESS",
        "streetLineOne": "Mike St",
        "streetLineTwo": "Sulley Ln",
        "city": "ANAHEIM",
        "postalCode": "92802",
        "countrySubdivisionCode": "CA",
        "countryCode": "US"
      }
    ],
    "legalId": {
      "legalIdValue": "995886885"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.