Locations

Endpoint:https://api.paychex.com/companies/{companyId}/locations

Verbs supported: GET

GET: Array of locations set at the company level.

Request:

Element NameTypeDescription
companyId stringThe ID of the company.

Endpoint:https://api.paychex.com/companies/{companyId}/locations?asof=2019-01-10T00:00:00Z

Verbs supported: GET

GET: Array of locations set at the company level based on a specific moment in time.

Request:

Element NameTypeDescription
companyId stringThe ID of the company.
asofDateThe date for what the locations collect looks like.

Response: Location Profile  

Endpoint:https://api.paychex.com/companies/{companyId}/locations/{locationId}

Verbs supported: GET

GET: Information about a single Location.

Request:

Element NameTypeDescription
companyId stringThe ID of the company.
locationIdstringThe ID of the location.

Endpoint:https://api.paychex.com/companies/{companyId}/locations/{locationId}?asof=2019-01-18T00:00:00Z

Verbs supported: GET

GET: Information about a single Location for a specific date.

Request:

Element NameTypeDescription
companyId stringThe ID of the company.
locationIdstringThe ID of the location.
asofDateThe date for what the location looks like.

Response: Location Profile  

Response

Profile: Locations

The state representation of Locations within a company.
Element NameTypeDescription
locationIdstringThe unique identifier associated with this locations representation.
namestringThe name of the location.
addressobjectThe address.
movedIndateThe date which the location was moved into.

 

Object Components:

address: Data elements of a locations address.

Element NameTypeDescription
streetLineOnestringThe street address line one
streetLineTwostringThe street address line two
postOfficeBoxstringThe postal office box
citystringThe city name
countrySubdivisionCodestringThe state code (ISO 3166 subdivision code)
postalCodestringThe zip-code
countryCodestringThe country code (ISO 3166 alpha-2)
{
  "content": [
     {
            "locationId": "970000082973090",
            "name": "Default Location",
            "address": {
                "streetLineOne": "1517 Empire Blvd",
                "city": "Webster",
                "postalCode": "14580",
                "countrySubdivisionCode": "NY",
                "countryCode": "US"
            }
        },
        {
            "locationId": "970000106981852",
            "name": "Location1",
            "address": {
                "streetLineOne": "675 Basket Rd",
                "city": "Webster",
                "postalCode": "14580",
                "countrySubdivisionCode": "NY",
                "countryCode": "US"
            },
            "movedIn": "2017-07-25T00:00:00Z"
        },
        {
            "locationId": "970001451713467",
            "name": "Location 2",
            "address": {
                "streetLineOne": "1891 Ridge Rd",
                "city": "Webster",
                "postalCode": "14580",
                "countrySubdivisionCode": "NY",
                "countryCode": "US"
            },
            "movedIn": "2017-07-25T00:00:00Z"
        }
  ]
}