Pay Period Settings API

To get pay period configuration in Zoho People.

Request URL:

https://people.zoho.com/people/api/payperiod/settings

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Scope:

ZOHOPEOPLE.payroll.ALL

Possible Operation Types:

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

Request Parameters:

No parameters are required to invoke this API.

Threshold Limit: 30 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/people/api/payperiod/settings

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Response

Copied{
   "payperiod_settings":[
      {
         "id":"2652000001083001",
         "name":"Pay period cycle for Indian locations",
         "period":"Monthly",
         "type":1,
         "start_date":"29",
	     "end_date":"28",
         "closure_date":"4",
         "locations":{
            "2652000000107001":"Mumbai",
            "2652000000107005":"Delhi"
         }
      },
      {
         "id":"2652000001671001",
         "name":"US",
         "period":"Half Monthly",
         "type":4,
         "start_date":"1",
         "end_date":"15",
         "closure_date":"16",
         "start_date_2":"16",
         "end_date_2":"32",
         "closure_date_2":"1",
         "process_encashment":false,
         "locations":{
            "2652000000094011":"US"
         }
      }
   ],
   "message":"Data fetched successfully!",
   "uri":"/api/payperiod/settings",
   "status":1
}