Pay Period Details API

This API is used to fetch pay period details.

Request URL:

https://people.zoho.com/api/timetracker/getPayPeriodDetails?

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Scope:

ZOHOPEOPLE.timetracker.ALL
OR
ZOHOPEOPLE.timetracker.READ

Possible Operation Types:

ALL - Complete access to data
READ - Only to read data

Request Parameters:

Parameters	Values Allowed	Default Value	Description
userErecNo	< all \| ERECNO \| Email-ID \| Employee-ID >	all	Specify the user whose pay period details needs to be fetched
locationName	<location Name>	all	Used to fetch pay period details based on location Name
locationId	<locationId>	all	Used to fetch pay period details based on location Id

Error Codes & Messages

Error Code	Error Message
9000	Permission Denied
9002	No Parameter Specified

Note 1: Either one of the parameters (userErecno,locationName,locationId) should be passed or none.

Note 2: If no parameter is passed all pay period data will be fetched.

Note 3: Admin can only access this api.

Success Response Format

{
"response": {
"result": [
{
"locationList" : [ pay period configured locations ]
"startDate": <Pay period Start Date>,
"end Date": <Pay period End Date>,
"payPeriodName": <Pay Period Name>,
"payPeriodId": <Pay Period Id>,
"freezeEnabaled": < Freeze enabled are not for PayPeriod After processing date>,
"frequency": <frequency of pay period>,
},....
],
"message": "Payroll Report data fetched successfully",
"uri": "/api/timetracker/getPayPeriodDetails",
"status": 0
}}

Error Response Format

{
"response": {
"message": "Error in fetching data",
"uri": "/api/timetracker/getPayPeriodDetails",
"errors": [
{
"code": < error_code >,
"message": < error_message >
}],
"status": 1
}

Threshold Limit: 20 requests | Lock period: 5 minutes

Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.

Sample Request

Copiedhttps://people.zoho.com/api/timetracker/getPayPeriodDetails?locationName=Allahabad

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Sample Response

Json XML

Copied{
    "response": {
        "result": [
            {
                "locationList": [
                    "Allahabad"
                ],
                "endDate": "2021-05-24",
                "payPeriodName": "saas",
                "processingDate": "2021-06-04",
                "paypPeriodId": "111796000003778019",
                "freezeEnabled": false,
                "startDate": "2021-05-03",
                "frequency": "Monthly"
            }
        ],
        "message": "Pay Period Details fetched successfully",
        "uri": "/api/timetracker/getPayPeriodDetails",
        "status": 0
    }
}

Copied<?xml version="1.0" encoding="UTF-8"?>
<response uri="/api/timetracker/getPayPeriodDetails">
    <status>0</status>
    <message>Pay Period Details fetched successfully</message>
    <result>
        <userReport>
            <locationList>[Allahabad]</locationList>
            <endDate>2021-05-24</endDate>
            <payPeriodName>saas</payPeriodName>
            <processingDate>2021-06-04</processingDate>
            <paypPeriodId>111796000003778019</paypPeriodId>
            <freezeEnabled>false</freezeEnabled>
            <startDate>2021-05-03</startDate>
            <frequency>Monthly</frequency>
        </userReport>
    </result>
</response>