Payer API

You can call this API to post the details of payers and also you can fetch details of payers and count payers using this API

Payer Entity

The various properties are explained below:

Param

Type

Required

Description

id

32 bit hex

Yes

Payer ID

(Auto generated while posting)

name

string

Yes

Name of Payer

tan

string

Yes

TAN Number of Payer in valid format

pan

string

Yes

PAN Number of Payer in valid format

If one is not required to have PAN, mention PANNOTREQD

gstin

string

No

GST Number of Payer

tan_registration_number

string

No

TAN Registration Number of Payer

branch

string

Yes

Branch/Division

Mention NA if doesn't exist

addresses

Array of Address

Yes

Array of Address

contacts

Array of Contact

Yes

Array of Contact

responsible_person

Employee

Yes

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

Yes

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

Yes

Employee Address

contact

Contact

Yes

Employee Contact

residential_status

string

No

Residential Status, Possible Values: Resident, Non Resident, Not Ordinarily Resident

Address Entity

Use other non mandatory fields such as area, district and city for complete address.

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

state

string

Yes

State

See Annexure 1‚Äč

street

string

Yes

Street (Max Length: 25)

area

string

No

Area

city

string

No

City

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