Pay Frequencies

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

Verbs supported: GET

GET: Array of pay frequencies that workers maybe paid on. This is a generic array that is currently not specific to the companies pay frequency. This is to be used with the workers pay components to determine what the frequency, occurrence, and intervals are allowed.

Request:

Element NameTypeDescription
companyId stringThe ID of the company.

Endpoint: https://api.paychex.com/companies/{companyId}/payfrequencies?payfrequency={payFrequency}

Verbs supported: GET

GET: Array of pay frequencies that are specific to a pay frequency. This can be used for determining the frequency, occurrence, and intervals that can be used with the workers payFrequency in the compensations pay standards by passing into the query.

Request:

Element NameTypeDescription
companyId stringThe ID of the company.
payFrequencystringThe frequency that you would like to search for.

Response: Pay Frequencies Profile  

Response

Profile: Pay Frequencies

The state representation of generic pay frequencies.
Element NameTypeDescription
payFrequencystringFrequency which the pay component would be applied.
payComponentFrequencyobjectFrequency that the options.


Pay Component Frequency

Element NameTypeDescription
appliedstringCurrently we only support a BY_PAY_PERIOD value for the API.
occurrencestringThis is how often the to be applied on the pay run.
occuranceIntervalsobjectThese are sub intervals that are used for occurrences that are larger in duration that allow you to define when to apply the pay component.

 

{
    {
    "metadata": {
        "contentItemCount": 71
    },
    "content": [
        {
            "payFrequency": "WEEKLY",
            "payComponentFrequency": {
                "applied": "BY_PAY_PERIOD",
                "occurrence": "SEMI_MONTHLY",
                "occurrenceIntervals": {
                    "interval1": "1",
                    "interval2": "4"
                }
            }
        },
        {
            "payFrequency": "WEEKLY",
            "payComponentFrequency": {
                "applied": "BY_PAY_PERIOD",
                "occurrence": "SEMI_MONTHLY",
                "occurrenceIntervals": {
                    "interval1": "1",
                    "interval2": "Last"
                }
            }
        }
],
    "links": [
        {
            "rel": "self",
            "href": "https://api.paychex.com/companies/00Z5V9BTIJOPZF9Y0NU3/payFrequencies"
        }
    ]
}