Payer API

Payer Entity
The various properties are explained below:
Param
Type
Required
Description
id
32 bit hex
Yes
Payer ID
name
string
Yes
Name of Payer
tan
string
Yes
TAN Number of Payer
pan
string
Yes
PAN Number of Payer
(If deductor is not required to have a PAN, mention PANNOTREQD)
gstin
string
No
GST Number of Payer
tan_registration_number
string
No
TAN Registration Number of Payer
branch
string
No
Branch
addresses
Array of Address
No
Array of Address
contacts
Array of Contact
No
Array of Contact
responsible_person
Employee
No
Responsible Person
Employee Entity
The various properties are explained below:
Param
Type
Required
Description
id
32 bit hex
Yes
Reference of Payer ID
employee_code
string
No
Employee Code
designation
string
No
Employee Designation
from
string
No
Employment Start Date
Format: DD/MM/YYYY
to
string
No
Employment End Date
Format: DD/MM/YYYY
category
string
No
Employee Category
name
string
Yes
Employee Full Name
fathers_name
string
No
Father's Name of Employee
dob
string
No
Employee Date of Birth
gender
string
No
Employee Gender 
Possible Values: Male, Female
pan
string
Yes
Employee PAN
address
Address
No
Employee Address
contact
Contact
No
Employee Contact
residential_status
string
No
Residential Status, Possible Values: Resident, Non Resident, Not Ordinarily Resident
Address Entity
The various properties are explained below:
Param
Type
Required
Description
id
32 bit hex
Yes
Reference of Payer ID
type
string
No
Type
is_primary
Boolean
No
Primary Address or Not
street
string
Yes
Street (Max Length: 25)
area
string
No
Area
city
string
No
City
state
string
Yes
State
postal_code
string
Yes
Postal Code
district
string
No
District
country
string
No
Country
full_address
string
No
Complete Address
Contact Entity
The various properties are explained below:
Param
Type
Required
Description
id
32 bit hex
Yes
Reference of Payer ID
email
string
Yes
Email Address
mobile
string
Yes
10 digit mobile number

Payers API

Fetch Payers

Last updated 3 days ago

Param	Type	Required	Description
id	`32 bit hex`	Yes	Payer ID
name	`string`	Yes	Name of Payer
tan	`string`	Yes	TAN Number of Payer
pan	`string`	Yes	PAN Number of Payer (If deductor is not required to have a PAN, mention PANNOTREQD)
gstin	`string`	No	GST Number of Payer
tan_registration_number	`string`	No	TAN Registration Number of Payer
branch	`string`	No	Branch
addresses	`Array of Address`	No	Array of Address
contacts	`Array of Contact`	No	Array of Contact
responsible_person	`Employee`	No	Responsible Person