{"info":{"_postman_id":"3364a861-b8b3-479c-a616-a003245a0dfd","name":"RazorpayX Payroll - Partner APIs","description":"

Base URL:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
EnvironmentURL
Productionhttps://payroll.razorpay.com
Stage (Test)https://payroll-demo.razorpay.com
\n

Authentication:

\n

We support 2 kinds of authentication.

\n

First is similar to V1 APIs, which can be used by our clients directly to view or update information about their people in their organisation. For using this, you need to send the API ID and API key set by you in organisation settings in the header with key names x-api-id and x-api-key. That is:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Header key nameKey value
x-api-id{{your-api-id}}
x-api-key{{your-api-key-value}}
\n

Second is for our integration partners. They can access the data of people of organisations which are integrated with them using the combination of 2 another set of keys: x-partner-key and x-client-key. That is:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Header key nameKey value
x-partner-key{{your-partner-key}}
x-client-key{{your-client-key-for-that-specific-org}}
\n

Remember, you can only use either of the one authentication approach in an API request, and cannot send all the 4 keys together (which ideally you should not know either).

\n

Upcoming APIs:

\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"23869703","collectionId":"3364a861-b8b3-479c-a616-a003245a0dfd","publishedId":"2s847MrAqf","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-01-11T17:40:33.000Z"},"item":[{"name":"People APIs","item":[{"name":"People","id":"afb99a44-9833-4a7e-8105-0e7d4e4ea74d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-partner-key","value":"{{x-partner-key}}","type":"text"},{"key":"x-client-key","value":"{{x-client-key}}","type":"text"}],"url":"{{base}}/partner/api/v2/people/{{id}}","description":"

Get a people entity from id. Response entities would be null if anything is not set.

\n

Response parameters:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
keydescription
idinteger Unique internal identifier
namestring Name of employee/contractor
typestring Enum between employee or contractor
emailstring Email of employee
employee_idstring EmployeeId with prefix according to organisation settings
hire_datestring Date in format dd-mm-yyyy
panstring PAN number
uanstring UAN number
date_of_birthstring Date in format dd-mm-yyyy
phone_numberstring Phone number
genderstring Either male, female or other.
job_titlestring Job title of the user
departmentstring Department of the user
bank_ifscstring Bank IFSC number
bank_account_numberstring Bank Account Number
manager_idinteger Manager unique identifier
manager_employee_idstring Manager employer Id with prefix (if applicable)
manager_emailstring Manager email address
is_pt_enabledboolean Flag to enable PT
is_pf_enabledboolean Flag to enable PF
statestring State name. Enum - possible states names given in separate table
stop_salaryboolean Flag to stop salary of user
is_activeboolean Flag showing user active or not
dismissal_datestring Date in format dd-mm-yyyy
optional_user_dataobject More details in separate table
created_attimestamp Created at unix epoch timestamp
updated_attimestamp Updated at unix epoch timestamp
\n

Optional user data response

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
keydescription
personal_phone_numberstring Personal phone number
personal_email_addressstring Personal email address
father_namestring Father's name
father_dobstring Father's DOB
mother_namestring Mother's name
mother_dobstring Mother's DOB
spouse_namestring Spouse's name
spouse_dobstring Spouse's DOB
child_1_namestring Name of first child
child_2_namestring Name of second child
permanent_addressstring Permanent address
temporary_addressstring Temporary address
highest_qualificationstring Highest qualification
aadhaar_numberstring Aadhaar number
marital_statusstring Marital status
previous_employerstring Previous employer
previous_designationstring Previous designation
marriage_anniversarystring Marriage anniversary
emergency_contact_namestring Emergency contact name
emergency_contact_numberstring Emergency contact number
emergency_contact_relationstring Emergency contact relation
blood_groupstring Blood group
nationalitystring Nationality
custom_1string First custom field set by organisation admins.
custom_2string Second custom field set by organisation admins.
custom_3string Third custom field set by organisation admins.
custom_4string Fourth custom field set by organisation admins.
custom_5string Fifth custom field set by organisation admins.
\n

Note: Key names of custom optional user data are not returned by APIs. They are expected to be known to the customer.

\n

Possible State names in response:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameName
Andaman and Nicobar IslandsAndhra Pradesh
Arunachal PradeshAssam
BiharChandigarh
ChhattisgarhDadra and Nagar Haveli
Daman and DiuDelhi
GoaGujarat
HaryanaHimachal Pradesh
Jammu and KashmirJharkhand
KarnatakaKerala
LakshadweepMadhya Pradesh
MaharashtraManipur
MeghalayaMizoram
NagalandOdisha
PuducherryPunjab
RajasthanSikkim
Tamil NaduTamil Nadu (Tiruchirappalli)
TelanganaTripura
Uttar PradeshUttarakhand
West Bengal
\n

In case of error:
Status Code >= 400

\n
{\n    \"error_code\": {error_code},              //string\n    \"error_description\": {error_description} //string\n}\n\n

Possible error codes:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error codeDetails
UNAUTHORIZEDYou are not authorized to perform this action
USER_NOT_FOUNDNo user found from given ID
UNKNOWN_EXCEPTIONSome unknown exception occurred
\n
","urlObject":{"path":["partner","api","v2","people","{{id}}"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"e19aec16-1c6d-4b95-88d7-17310fdbc058","name":"People","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"text/html","type":"text","disabled":true},{"key":"x-partner-key","value":"{{x-partner-key}}","type":"text"},{"key":"x-client-key","value":"{{x-client-key}}","type":"text"},{"key":"","value":"","type":"text","disabled":true},{"key":"","value":"","type":"text","disabled":true}],"url":"{{base}}/partner/api/v2/people/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 19502,\n \"name\": \"Test Name9\",\n \"type\": \"contractor\",\n \"email\": \"testingfromapi9@mailinator.com\",\n \"employee_id\": \"CONTA1036\",\n \"hire_date\": \"30-05-2020\",\n \"pan\": null,\n \"uan\": null,\n \"date_of_birth\": null,\n \"phone_number\": null,\n \"gender\": \"male\",\n \"job_title\": \"Designer\",\n \"department\": \"Payments\",\n \"bank_ifsc\": \"\",\n \"bank_account_number\": \"\",\n \"manager_id\": 678,\n \"manager_employee_id\": \"EMP110\",\n \"is_pt_enabled\": false,\n \"is_pf_enabled\": true,\n \"state\": \"haryana\",\n \"stop_salary\": false,\n \"is_active\": true,\n \"dismissal_date\": null,\n \"optional_user_data\": {\n \"personal_phone_number\": \"9999911011\",\n \"personal_email_address\": null,\n \"father_name\": null,\n \"father_dob\": null,\n \"mother_name\": null,\n \"mother_dob\": null,\n \"spouse_name\": null,\n \"spouse_dob\": null,\n \"child_1_name\": null,\n \"child_2_name\": null,\n \"permanent_address\": null,\n \"temporary_address\": null,\n \"highest_qualification\": null,\n \"aadhaar_number\": null,\n \"marital_status\": \"single\",\n \"work_experience\": null,\n \"previous_employer\": null,\n \"previous_designation\": null,\n \"marriage_anniversary\": null,\n \"emergency_contact_name\": null,\n \"emergency_contact_number\": null,\n \"emergency_contact_relation\": null,\n \"blood_group\": null,\n \"nationality\": null,\n \"custom_1\": \"hello\",\n \"custom_2\": null,\n \"custom_3\": null,\n \"custom_4\": null,\n \"custom_5\": null\n },\n \"created_at\": 1640070550,\n \"updated_at\": 1640071015\n}"}],"_postman_id":"afb99a44-9833-4a7e-8105-0e7d4e4ea74d"},{"name":"People","id":"2aa596e7-2391-4530-9277-7ebc7ab9280a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-id","value":"{{x-api-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Test Name11\",\n \"type\": \"contractor\", \n \"email\": \"testingfromapi11@mailinator.com\", \n \"employee_id\": \"CONTA1171\", \n \"hire_date\": \"30-05-2020\", \n \"uan\": null,\n \"phone_number\": \"9999999999\",\n \"gender\": \"male\",\n \"job_title\": \"Designer\", \n \"department\": \"Payments\", \n \"manager_id\": 678, \n \"is_pt_enabled\": false,\n \"is_pf_enabled\": true, \n \"state\": \"haryana\",\n \"stop_salary\": false,\n \"manager_employee_type\": null,\n \"past_payroll\": {\n \"past_salary\": 100,\n \"past_exemption\": 0,\n \"past_tds\": 0,\n \"previous_employer_salary\": 0,\n \"previous_employer_tds\": 0\n },\n \"optional_user_data\": {\n \"personal_phone_number\": \"9999911011\",\n \"personal_email_address\": null,\n \"father_name\": null,\n \"father_dob\": null,\n \"mother_name\": null,\n \"mother_dob\": null,\n \"spouse_name\": null,\n \"spouse_dob\": null,\n \"child_1_name\": null,\n \"child_2_name\": null,\n \"permanent_address\": null,\n \"temporary_address\": null,\n \"highest_qualification\": null,\n \"aadhaar_number\": null,\n \"marital_status\": \"single\",\n \"work_experience\": null,\n \"previous_employer\": null, \n \"previous_designation\": null,\n \"marriage_anniversary\": null,\n \"emergency_contact_name\": null,\n \"emergency_contact_number\": null,\n \"emergency_contact_relation\": null,\n \"blood_group\": null,\n \"nationality\": null,\n \"custom_1\": \"hello\",\n \"custom_2\": null,\n \"custom_3\": null,\n \"custom_4\": null,\n \"custom_5\": null\n }\n}\n ","options":{"raw":{"language":"json"}}},"url":"{{base}}/partner/api/v2/people","description":"

Create a people entry.

\n

Request Body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
keydescription
namestring required Name of employee/contractor
typestring required Enum between employee or contractor
emailstring required Email of employee
employee_idstring EmployeeId with prefix according to organisation settings
hire_datestring Date in format dd-mm-yyyy
panstring PAN number
uanstring nullable UAN number
date_of_birthstring Date in format dd-mm-yyyy
phone_numberstring Phone number
genderstring Either one of male, female or other.
job_titlestring nullable Job title of the user
departmentstring Department of the user
bank_ifscstring Bank IFSC number
bank_account_numberstring Bank Account Number
manager_idinteger nullable Manager unique identifier
is_pt_enabledboolean Flag to enable PT
is_pf_enabledboolean Flag to enable PF
statestring nullable State name. Enum - possible states names same as response of GET API - with completely in lowercase.
optional_user_dataobject More details in separate table
\n

Optional user data request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
keydescription
personal_phone_numberstring nullable Personal phone number
personal_email_addressstring nullable Personal email address
father_namestring nullable Father's name
father_dobstring nullable Father's DOB - in format dd-mm-yyyy
mother_namestring nullable Mother's name
mother_dobstring nullable Mother's DOB - in format dd-mm-yyyy
spouse_namestring nullable Spouse's name
spouse_dobstring nullable Spouse's DOB - in format dd-mm-yyyy
child_1_namestring nullable Name of first child
child_2_namestring nullable Name of second child
permanent_addressstring nullable Permanent address
temporary_addressstring nullable Temporary address
highest_qualificationstring nullable Highest qualification
aadhaar_numberstring nullable Aadhaar number
marital_statusstring nullable Marital status
previous_employerstring nullable Previous employer
previous_designationstring nullable Previous designation
marriage_anniversarystring nullable Marriage anniversary - in format dd-mm-yyyy
emergency_contact_namestring nullable Emergency contact name
emergency_contact_numberstring nullable Emergency contact number
emergency_contact_relationstring nullable Emergency contact relation
blood_groupstring nullable Blood group
nationalitystring nullable Nationality
custom_1string nullable Value of first custom field set by organisation admins.
custom_2string nullable Value of second custom field set by organisation admins.
custom_3string nullable Value of third custom field set by organisation admins.
custom_4string nullable Value of fourth custom field set by organisation admins.
custom_5string nullable Value of fifth custom field set by organisation admins.
\n

Note: Key names of custom optional user data should not be provided. We automatically match it with the key names set by the organisation admins.

\n

In case of error:

\n

Status Code >= 400

\n
{\n    \"error_code\": {error_code},              //string\n    \"error_description\": {error_description} //string\n}\n\n

Possible error codes:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error codeDetails
UNAUTHORIZEDYou are not authorized to perform this action
INVALID_DATASome invalid request body data provided
EMAIL_ALREADY_EXISTSIf given email is already in use
EMPLOYEE_ID_NOT_AVAILABLEEmployee Id is already in use
UNKNOWN_EXCEPTIONSome unknown exception occurred
\n
","urlObject":{"path":["partner","api","v2","people"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"ed4124a7-244c-4c3c-a154-fab6f3b19208","name":"People","originalRequest":{"method":"POST","header":[{"key":"x-api-id","value":"{{x-api-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"","value":"","type":"text","disabled":true},{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"name\": \"Test Name11\",\n \"type\": \"contractor\", \n \"email\": \"testingfromapi11@mailinator.com\", \n \"employee_id\": \"CONTA1171\", \n \"hire_date\": \"30-05-2020\", \n \"uan\": null,\n \"phone_number\": \"9999999999\",\n \"gender\": \"male\",\n \"job_title\": \"Designer\", \n \"department\": \"Payments\", \n \"manager_id\": 678, \n \"is_pt_enabled\": false,\n \"is_pf_enabled\": true, \n \"state\": \"haryana\",\n \"stop_salary\": false,\n \"past_payroll\": {\n \"past_salary\": 100,\n \"past_exemption\": 0,\n \"past_tds\": 0,\n \"previous_employer_salary\": 0,\n \"previous_employer_tds\": 0\n },\n \"optional_user_data\": {\n \"personal_phone_number\": \"9999911011\",\n \"personal_email_address\": null,\n \"father_name\": null,\n \"father_dob\": null,\n \"mother_name\": null,\n \"mother_dob\": null,\n \"spouse_name\": null,\n \"spouse_dob\": null,\n \"child_1_name\": null,\n \"child_2_name\": null,\n \"permanent_address\": null,\n \"temporary_address\": null,\n \"highest_qualification\": null,\n \"aadhaar_number\": null,\n \"marital_status\": \"single\",\n \"work_experience\": null,\n \"previous_employer\": null, \n \"previous_designation\": null,\n \"marriage_anniversary\": null,\n \"emergency_contact_name\": null,\n \"emergency_contact_number\": null,\n \"emergency_contact_relation\": null,\n \"blood_group\": null,\n \"nationality\": null,\n \"custom_1\": \"hello\",\n \"custom_2\": null,\n \"custom_3\": null,\n \"custom_4\": null,\n \"custom_5\": null\n }\n}\n ","options":{"raw":{"language":"json"}}},"url":"{{base}}/partner/api/v2/people"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 19509,\n \"name\": \"Test Name11\",\n \"type\": \"contractor\",\n \"email\": \"testingfromapi11@mailinator.com\",\n \"employee_id\": \"CONTA1171\",\n \"hire_date\": \"30-05-2020\",\n \"pan\": null,\n \"uan\": null,\n \"date_of_birth\": null,\n \"phone_number\": \"9999999999\",\n \"gender\": \"male\",\n \"job_title\": \"Designer\",\n \"department\": \"Payments\",\n \"bank_ifsc\": \"\",\n \"bank_account_number\": \"\",\n \"manager_id\": 678,\n \"manager_employee_id\": \"EMP110\",\n \"is_pt_enabled\": false,\n \"is_pf_enabled\": true,\n \"state\": \"Haryana\",\n \"stop_salary\": false,\n \"is_active\": false,\n \"dismissal_date\": null,\n \"optional_user_data\": {\n \"personal_phone_number\": \"9999911011\",\n \"personal_email_address\": null,\n \"father_name\": null,\n \"father_dob\": null,\n \"mother_name\": null,\n \"mother_dob\": null,\n \"spouse_name\": null,\n \"spouse_dob\": null,\n \"child_1_name\": null,\n \"child_2_name\": null,\n \"permanent_address\": null,\n \"temporary_address\": null,\n \"highest_qualification\": null,\n \"aadhaar_number\": null,\n \"marital_status\": \"single\",\n \"work_experience\": null,\n \"previous_employer\": null,\n \"previous_designation\": null,\n \"marriage_anniversary\": null,\n \"emergency_contact_name\": null,\n \"emergency_contact_number\": null,\n \"emergency_contact_relation\": null,\n \"blood_group\": null,\n \"nationality\": null,\n \"custom_1\": \"hello\",\n \"custom_2\": null,\n \"custom_3\": null,\n \"custom_4\": null,\n \"custom_5\": null\n },\n \"created_at\": 1640138243,\n \"updated_at\": 1640569923\n}"}],"_postman_id":"2aa596e7-2391-4530-9277-7ebc7ab9280a"},{"name":"People","id":"e9c8d4ee-cd09-4923-bc75-801a8dc65fa2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-id","value":"{{x-api-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"x-partner-key","value":"{{x-partner-key}}","type":"text"},{"key":"x-client-key","value":"{{x-client-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Test Name11\",\n \"type\": \"contractor\", \n \"employee_id\": \"CONTA1175\", \n \"hire_date\": \"30-05-2020\", \n \"pan\": \"BXQPG4756C\",\n \"uan\": null,\n \"phone_number\": \"9999999999\",\n \"gender\": \"male\",\n \"job_title\": \"Designer\", \n \"department\": \"Payments\", \n \"manager_id\": 678, \n \"is_pt_enabled\": false,\n \"is_pf_enabled\": true, \n \"state\": \"haryana\",\n \"optional_user_data\": {\n \"personal_phone_number\": \"9999911011\",\n \"personal_email_address\": null,\n \"father_name\": null,\n \"father_dob\": null,\n \"mother_name\": null,\n \"mother_dob\": null,\n \"spouse_name\": null,\n \"spouse_dob\": null,\n \"child_1_name\": null,\n \"child_2_name\": null,\n \"permanent_address\": null,\n \"temporary_address\": null,\n \"highest_qualification\": null,\n \"aadhaar_number\": null,\n \"marital_status\": \"single\",\n \"work_experience\": null,\n \"previous_employer\": null, \n \"previous_designation\": null,\n \"marriage_anniversary\": null,\n \"emergency_contact_name\": null,\n \"emergency_contact_number\": null,\n \"emergency_contact_relation\": null,\n \"blood_group\": null,\n \"nationality\": null,\n \"custom_1\": \"hello\",\n \"custom_2\": null,\n \"custom_3\": null,\n \"custom_4\": null,\n \"custom_5\": null\n }\n}\n ","options":{"raw":{"language":"json"}}},"url":"{{base}}/partner/api/v2/people/{{id}}","description":"

Update a people entity.

\n

Request Body:

\n

Exactly same as POST request body, except following things:

\n
    \n
  1. You cannot update email of the user.
    2. \n
  2. None of the key is required. Every key is optional.
    3. \n
\n

Keys which are not nullable, you cannot set them to null. If you don't want to update any key and do not know it's current value, just don't provide that key in the request body.

\n

In case of error:

\n

Status Code >= 400

\n
{\n    \"error_code\": {error_code},              //string\n    \"error_description\": {error_description} //string\n}\n

Possible error codes:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error codeDetails
UNAUTHORIZEDYou are not authorized to perform this action
INVALID_DATASome invalid request body data provided
USER_NOT_FOUNDNo user found from given ID
EMAIL_ALREADY_EXISTSIf given email is already in use
EMPLOYEE_ID_NOT_AVAILABLEEmployee Id is already in use.
UNKNOWN_EXCEPTIONSome unknown exception occurred
\n
","urlObject":{"path":["partner","api","v2","people","{{id}}"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"0e6920f5-9245-4f89-95f3-b6a251d7c9a9","name":"People","originalRequest":{"method":"PATCH","header":[{"key":"x-api-id","value":"{{x-api-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"x-partner-key","value":"{{x-partner-key}}","type":"text"},{"key":"x-client-key","value":"{{x-client-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Test Name11\",\n \"type\": \"contractor\", \n \"employee_id\": \"CONTA1175\", \n \"hire_date\": \"30-05-2020\", \n \"pan\": \"BXQPG4756C\",\n \"uan\": null,\n \"phone_number\": \"9999999999\",\n \"gender\": \"male\",\n \"job_title\": \"Designer\", \n \"department\": \"Payments\", \n \"manager_id\": 678, \n \"is_pt_enabled\": false,\n \"is_pf_enabled\": true, \n \"state\": \"haryana\",\n \"stop_salary\": false,\n \"past_payroll\": {\n \"past_salary\": 100,\n \"past_exemption\": 0,\n \"past_tds\": 0,\n \"previous_employer_salary\": 0,\n \"previous_employer_tds\": 0\n },\n \"optional_user_data\": {\n \"personal_phone_number\": \"9999911011\",\n \"personal_email_address\": null,\n \"father_name\": null,\n \"father_dob\": null,\n \"mother_name\": null,\n \"mother_dob\": null,\n \"spouse_name\": null,\n \"spouse_dob\": null,\n \"child_1_name\": null,\n \"child_2_name\": null,\n \"permanent_address\": null,\n \"temporary_address\": null,\n \"highest_qualification\": null,\n \"aadhaar_number\": null,\n \"marital_status\": \"single\",\n \"work_experience\": null,\n \"previous_employer\": null, \n \"previous_designation\": null,\n \"marriage_anniversary\": null,\n \"emergency_contact_name\": null,\n \"emergency_contact_number\": null,\n \"emergency_contact_relation\": null,\n \"blood_group\": null,\n \"nationality\": null,\n \"custom_1\": \"hello\",\n \"custom_2\": null,\n \"custom_3\": null,\n \"custom_4\": null,\n \"custom_5\": null\n }\n}\n \n ","options":{"raw":{"language":"json"}}},"url":"{{base}}/v2/api/v2/people/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 19502,\n \"name\": \"Test Name11\",\n \"type\": \"contractor\",\n \"email\": \"testingfromapi9@mailinator.com\",\n \"employee_id\": \"CONTA1175\",\n \"hire_date\": \"30-05-2020\",\n \"pan\": \"BXQPG4756C\",\n \"uan\": null,\n \"date_of_birth\": null,\n \"phone_number\": \"9999999999\",\n \"gender\": \"male\",\n \"job_title\": \"Designer\",\n \"department\": \"Payments\",\n \"bank_ifsc\": \"\",\n \"bank_account_number\": \"\",\n \"manager_id\": 678,\n \"manager_employee_id\": \"EMP110\",\n \"is_pt_enabled\": false,\n \"is_pf_enabled\": true,\n \"state\": \"Haryana\",\n \"stop_salary\": false,\n \"is_active\": true,\n \"dismissal_date\": null,\n \"optional_user_data\": {\n \"personal_phone_number\": \"9999911011\",\n \"personal_email_address\": null,\n \"father_name\": null,\n \"father_dob\": null,\n \"mother_name\": null,\n \"mother_dob\": null,\n \"spouse_name\": null,\n \"spouse_dob\": null,\n \"child_1_name\": null,\n \"child_2_name\": null,\n \"permanent_address\": null,\n \"temporary_address\": null,\n \"highest_qualification\": null,\n \"aadhaar_number\": null,\n \"marital_status\": \"single\",\n \"work_experience\": null,\n \"previous_employer\": null,\n \"previous_designation\": null,\n \"marriage_anniversary\": null,\n \"emergency_contact_name\": null,\n \"emergency_contact_number\": null,\n \"emergency_contact_relation\": null,\n \"blood_group\": null,\n \"nationality\": null,\n \"custom_1\": \"hello\",\n \"custom_2\": null,\n \"custom_3\": null,\n \"custom_4\": null,\n \"custom_5\": null\n },\n \"created_at\": 1640070550,\n \"updated_at\": 1640589879\n}"}],"_postman_id":"e9c8d4ee-cd09-4923-bc75-801a8dc65fa2"},{"name":"People","id":"52529a19-b571-47cd-958e-a39d42da1596","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-id","value":"{{x-api-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"x-partner-key","value":"{{x-partner-key}}","type":"text"},{"key":"x-client-key","value":"{{x-client-key}}","type":"text"}],"url":"{{base}}/partner/api/v2/people/{{id}}","description":"

Delete a people entity
Expected Response on Success:
Status Code 200 OK

\n

In case of Error:

\n

Status Code >= 400

\n
{\n    \"error_code\": {error_code},              //string\n    \"error_description\": {error_description} //string\n}\n

Possible error codes:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error codeDetails
UNAUTHORIZEDYou are not authorized to perform this action
USER_NOT_FOUNDNo user found from given ID
USER_NOT_DISMISSEDUser needs to be dismissed before being deleted
USER_ALREADY_DELETEDUser is already deleted
UNKNOWN_EXCEPTIONSome unknown exception occurred
\n
","urlObject":{"path":["partner","api","v2","people","{{id}}"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"3c40c860-28a2-4c05-9439-e5bb3669683f","name":"People","originalRequest":{"method":"DELETE","header":[{"key":"x-api-id","value":"{{x-api-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"x-partner-key","value":"{{x-partner-key}}","type":"text"},{"key":"x-client-key","value":"{{x-client-key}}","type":"text"}],"url":"{{base}}/v2/api/v2/people/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"52529a19-b571-47cd-958e-a39d42da1596"},{"name":"Get ID","id":"110d8ff4-a801-466d-9c35-9e2c78f698de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-id","value":"{{x-api-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"x-partner-key","value":"{{x-partner-key}}","type":"text"},{"key":"x-client-key","value":"{{x-client-key}}","type":"text"}],"url":"{{base}}/partner/api/v2/people/id?email={{email}}&employee-id={{employee-id}}&type={{type}}","description":"

Get id of user from email or employee id
Some points to note down:

\n
    \n
  1. You can either use email in request parameters, or can use a combination of employee-id and type.
    2. \n
  2. If employee-id is used, it should have the correct prefix as per organisation's settings.
    3. \n
  3. Use URL encoding for special characters, like '+', in email. For eg, if your email id is abc+123@xyz.com, then you have to pass \"% 2B\" (without space between '%' and '2') instead of '+'. That is, pass email id as abc% 2B123@xyz,com (without space).
    4. \n
\n

Accepted query parameters:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Paramaterdescription
emailstring email id of required user
employee-idstring employee id of required user, with prefix (if applicable)
typestring employee type. Enum - either employee or contractor
\n

Response parameters:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
keydescription
idinteger unique identifier for that user
namestring Name of employee/contractor
emailstring Email of employee
typestring Enum between employee or contractor
employee_idstring EmployeeId with prefix according to organisation settings
\n
\n

In case of error:

\n

Status Code >= 400

\n
{\n    \"error_code\": {error_code},              //string\n    \"error_description\": {error_description} //string\n}\n

Possible error codes:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error codeDetails
UNAUTHORIZEDYou are not authorized to perform this action
USER_NOT_FOUNDNo user found from given details
INVALID_DATAInvalid data is given, eg. invalid employee type
UNKNOWN_EXCEPTIONSome unknown exception occurred
\n
","urlObject":{"path":["partner","api","v2","people","id"],"host":["{{base}}"],"query":[{"key":"email","value":"{{email}}"},{"key":"employee-id","value":"{{employee-id}}"},{"key":"type","value":"{{type}}"}],"variable":[]}},"response":[{"id":"0067b43a-60b2-478b-a70c-e46ecd195658","name":"Get ID From Email","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"x-api-id","value":"{{x-api-id}}","type":"text"},{"key":"x-partner-key","value":"{{x-partner-key}}","type":"text"},{"key":"x-client-key","value":"{{x-client-key}}","type":"text"}],"url":{"raw":"{{base}}/partner/api/v2/people/id?email={{email}}","host":["{{base}}"],"path":["partner","api","v2","people","id"],"query":[{"key":"email","value":"{{email}}"},{"key":"","value":"","disabled":true},{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 19502,\n \"name\": \"Test Name11\",\n \"email\": \"testingfromapi9@mailinator.com\",\n \"type\": \"contractor\",\n \"employee_id\": \"CONTA1175\"\n}"},{"id":"a429da37-ee27-4bda-8eac-9e9e3cb80323","name":"Get ID From Employee Id and Employee Type","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"x-api-id","value":"{{x-api-id}}","type":"text"},{"key":"x-partner-key","value":"{{x-partner-key}}","type":"text"},{"key":"x-client-key","value":"{{x-client-key}}","type":"text"}],"url":{"raw":"{{base}}/partner/api/v2/people/id?employee-id={{employee-id}}&type={{type}}","host":["{{base}}"],"path":["partner","api","v2","people","id"],"query":[{"key":"employee-id","value":"{{employee-id}}"},{"key":"type","value":"{{type}}"},{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 19502,\n \"name\": \"Test Name11\",\n \"email\": \"testingfromapi9@mailinator.com\",\n \"type\": \"contractor\",\n \"employee_id\": \"CONTA1175\"\n}"}],"_postman_id":"110d8ff4-a801-466d-9c35-9e2c78f698de"},{"name":"Get All","id":"bf4604fd-df6f-4b2d-9b6c-8d11d0377a38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-id","value":"{{x-api-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"x-partner-key","value":"{{x-partner-key}}","type":"text"},{"key":"x-client-key","value":"{{x-client-key}}","type":"text"}],"url":"{{base}}/partner/api/v2/people?page_number={{page_number}}&page_size={{page_size}}&name={{name}}&email={{email}}&type={{type}}&user_role={{user_role}}&created_from={{created_from}}&created_before={{created_before}}","description":"

Get all people entities of your organisation. It supports various filters and have pagination. None of the query parameter is mandatory.

\n

Available query parameters:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescriptionConstraintDefault Value
page_numberinteger Page number to fetch.page_number >= 11
page_sizeinteger Number of records per page.1 <= page_size <= 5020
namestring Filter to get records with name containing this stringNAno filter
emailstring Filter to get records with email containing this stringNAno filter
typestring Filter records on basis of employee typeshould be a string either 'employee' or 'contractor'no filter
user_rolestring Filter to get people of particular user roleshould be a string with one of the following user roles.no filter
created_fromstring Filter to get people who joined on or after a particular dateshould be a date of the format YYYY-MM-DD HH:MM:SS(IST, 24hr Format)no filter
created_beforestring Filter to get people who joined on or before a particular dateshould be a date of the format YYYY-MM-DD HH:MM:SS(IST, 24hr Format)no filter
\n

Possible User Roles:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
User RoleUser Role
ADMINHUMAN_RESOURCES
EXECUTE_PAYROLLVIEW_REPORTS
REIMBURSEMENTSCA
EMPLOYEE
\n

Response Parameters:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyDescription
page_countinteger Total number of pages present with current set of filters
page_numberinteger current page number
page_sizeinteger maximum number of records possible per page
peoplearray array of people objects. All People objects are exactly similar as the response of GET people from ID.
\n

In case of error:
Status Code >= 400

\n
{\n    \"error_code\": {error_code},              //string\n    \"error_description\": {error_description} //string\n}\n\n

Possible error codes:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error codeDetails
UNAUTHORIZEDYou are not authorized to perform this action
INVALID_DATASome invalid request parameter provided
UNKNOWN_EXCEPTIONSome unknown exception occurred
\n
Filtering based on Date:
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Filter byDate Filter Usage
On and after the given datecreated_from=fromDateTimeStamp
On and before the given datecreated_before=beforeDateTimeStamp
Date Rangecreated_from=fromDateTimeStamp&created_before=beforeDateTimeStamp such that fromDateTimeStamp < beforeDateTimeStamp
Single daycreated_from=fromDateTimeStamp&created_before=beforeDateTimeStamp such that fromDateTimeStamp = beforeDateTimeStamp
\n
","urlObject":{"path":["partner","api","v2","people"],"host":["{{base}}"],"query":[{"key":"page_number","value":"{{page_number}}"},{"key":"page_size","value":"{{page_size}}"},{"key":"name","value":"{{name}}"},{"key":"email","value":"{{email}}"},{"key":"type","value":"{{type}}"},{"key":"user_role","value":"{{user_role}}"},{"key":"created_from","value":"{{created_from}}"},{"key":"created_before","value":"{{created_before}}"}],"variable":[]}},"response":[{"id":"aa4ea01b-1b2a-4140-b376-912746c1e8bc","name":"Get All","originalRequest":{"method":"GET","header":[{"key":"x-api-id","value":"{{x-api-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"x-partner-key","value":"{{x-partner-key}}","type":"text"},{"key":"x-client-key","value":"{{x-client-key}}","type":"text"}],"url":{"raw":"{{base}}/partner/api/v2/people?pageNumber={{pageNumber}}&pageSize={{pageSize}}&name={{name}}&email={{email}}&type={{type}}&userRole={{userRole}}&created_from={{created_from}}&created_before={{created_before}}","host":["{{base}}"],"path":["partner","api","v2","people"],"query":[{"key":"pageNumber","value":"{{pageNumber}}"},{"key":"pageSize","value":"{{pageSize}}"},{"key":"name","value":"{{name}}"},{"key":"email","value":"{{email}}"},{"key":"type","value":"{{type}}"},{"key":"userRole","value":"{{userRole}}"},{"key":"created_from","value":"{{created_from}}","type":"text"},{"key":"created_before","value":"{{created_before}}","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"page_count\": 1,\n \"page_number\": 1,\n \"page_size\": 20,\n \"people\": [\n {\n \"id\": 19487,\n \"name\": \"Test Name\",\n \"type\": \"employee\",\n \"email\": \"testingfromapi@mailinator.com\",\n \"employee_id\": \"EMP100\",\n \"hire_date\": \"30-05-2020\",\n \"pan\": null,\n \"uan\": null,\n \"date_of_birth\": null,\n \"phone_number\": null,\n \"job_title\": \"Designer\",\n \"department\": \"Payments\",\n \"bank_ifsc\": null,\n \"bank_account_number\": null,\n \"manager_id\": 678,\n \"manager_employee_id\": \"EMP1176\",\n \"is_pt_enabled\": false,\n \"is_pf_enabled\": true,\n \"state\": \"Haryana\",\n \"stop_salary\": false,\n \"is_active\": true,\n \"optional_user_data\": {\n \"personal_phone_number\": \"9999911011\",\n \"personal_email_address\": null,\n \"father_name\": null,\n \"father_dob\": null,\n \"mother_name\": null,\n \"mother_dob\": null,\n \"spouse_name\": null,\n \"spouse_dob\": null,\n \"child_1_name\": null,\n \"child_2_name\": null,\n \"permanent_address\": null,\n \"temporary_address\": null,\n \"highest_qualification\": null,\n \"aadhaar_number\": null,\n \"marital_status\": \"single\",\n \"work_experience\": null,\n \"previous_employer\": null,\n \"previous_designation\": null,\n \"marriage_anniversary\": null,\n \"emergency_contact_name\": null,\n \"emergency_contact_number\": null,\n \"emergency_contact_relation\": null,\n \"blood_group\": null,\n \"nationality\": null,\n \"custom_1\": \"hello\",\n \"custom_2\": null,\n \"custom_3\": null,\n \"custom_4\": null,\n \"custom_5\": null\n },\n \"created_at\": 1640672239,\n \"updated_at\": 1640672239\n },\n {\n \"id\": 19489,\n \"name\": \"Test Name3\",\n \"type\": \"employee\",\n \"email\": \"testingfromapi3@mailinator.com\",\n \"employee_id\": \"EMP1011\",\n \"hire_date\": \"30-05-2020\",\n \"pan\": null,\n \"uan\": null,\n \"date_of_birth\": null,\n \"phone_number\": null,\n \"job_title\": \"Designer\",\n \"department\": \"Payments\",\n \"bank_ifsc\": null,\n \"bank_account_number\": null,\n \"manager_id\": 678,\n \"manager_employee_id\": \"EMP1176\",\n \"is_pt_enabled\": false,\n \"is_pf_enabled\": true,\n \"state\": \"Haryana\",\n \"stop_salary\": false,\n \"is_active\": true,\n \"optional_user_data\": {\n \"personal_phone_number\": \"9999911011\",\n \"personal_email_address\": null,\n \"father_name\": null,\n \"father_dob\": null,\n \"mother_name\": null,\n \"mother_dob\": null,\n \"spouse_name\": null,\n \"spouse_dob\": null,\n \"child_1_name\": null,\n \"child_2_name\": null,\n \"permanent_address\": null,\n \"temporary_address\": null,\n \"highest_qualification\": null,\n \"aadhaar_number\": null,\n \"marital_status\": \"single\",\n \"work_experience\": null,\n \"previous_employer\": null,\n \"previous_designation\": null,\n \"marriage_anniversary\": null,\n \"emergency_contact_name\": null,\n \"emergency_contact_number\": null,\n \"emergency_contact_relation\": null,\n \"blood_group\": null,\n \"nationality\": null,\n \"custom_1\": \"hello\",\n \"custom_2\": null,\n \"custom_3\": null,\n \"custom_4\": null,\n \"custom_5\": null\n },\n \"created_at\": 1640672239,\n \"updated_at\": 1640672239\n },\n {\n \"id\": 19490,\n \"name\": \"Test Name4\",\n \"type\": \"contractor\",\n \"email\": \"testingfromapi4+12@mailinator.com\",\n \"employee_id\": \"CONTA1012\",\n \"hire_date\": null,\n \"pan\": null,\n \"uan\": null,\n \"date_of_birth\": null,\n \"phone_number\": null,\n \"job_title\": null,\n \"department\": null,\n \"bank_ifsc\": \"\",\n \"bank_account_number\": \"\",\n \"manager_id\": null,\n \"manager_employee_id\": null,\n \"is_pt_enabled\": null,\n \"is_pf_enabled\": null,\n \"state\": null,\n \"stop_salary\": false,\n \"is_active\": true,\n \"optional_user_data\": {\n \"personal_phone_number\": null,\n \"personal_email_address\": null,\n \"father_name\": null,\n \"father_dob\": null,\n \"mother_name\": null,\n \"mother_dob\": null,\n \"spouse_name\": null,\n \"spouse_dob\": null,\n \"child_1_name\": null,\n \"child_2_name\": null,\n \"permanent_address\": null,\n \"temporary_address\": null,\n \"highest_qualification\": null,\n \"aadhaar_number\": null,\n \"marital_status\": null,\n \"work_experience\": null,\n \"previous_employer\": null,\n \"previous_designation\": null,\n \"marriage_anniversary\": null,\n \"emergency_contact_name\": null,\n \"emergency_contact_number\": null,\n \"emergency_contact_relation\": null,\n \"blood_group\": null,\n \"nationality\": null,\n \"custom_1\": null,\n \"custom_2\": null,\n \"custom_3\": null,\n \"custom_4\": null,\n \"custom_5\": null\n },\n \"created_at\": 1640672239,\n \"updated_at\": 1643939334\n }\n ]\n}"}],"_postman_id":"bf4604fd-df6f-4b2d-9b6c-8d11d0377a38"}],"id":"2a3d850e-2c34-4b98-8857-b4c59bb053df","_postman_id":"2a3d850e-2c34-4b98-8857-b4c59bb053df","description":""},{"name":"Contractor Payment APIs","item":[{"name":"Create","id":"6ba3f59c-b4e4-4258-9173-3e5ed9a86888","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-id","value":"{{x-api-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"x-partner-key","value":"{{x-partner-key}}","type":"text"},{"key":"x-client-key","value":"{{x-client-key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"from_email_id","value":"","type":"text"},{"key":"attachments[]","type":"file","value":null},{"key":"execute_on","value":"","type":"text"},{"key":"remarks","value":"","type":"text"},{"key":"purpose","value":"","type":"text"},{"key":"amount","value":"","type":"text"},{"key":"tax","value":"","type":"text"},{"key":"repeat_payment","value":"","type":"text"},{"key":"invoice_date","value":"","type":"text"}]},"url":"{{base}}/partner/api/v2/people/{{userOrgId}}/contractor-payment","description":"

Create a contractor payment

\n

URL Params Description

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
ParamDescription
{{userOrgId}}This value can be obtained from the Get ID People API.
\n

Body Fields Description

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyDescription
from_email_idstring required The email id of the person making the payment
attachments[]file(s) optionalThe invoice in pdf, jpg, jpeg or png format. This field is required only if organisation mandates invoice for contractor payments in XPayroll settings. Note: attachments must be sent only via multi-part form requests.
execute_onstring required The date on which you wish this payment to be executed. Date in format dd-mm-yyyy
remarksstring required A remark for this payment. We will include this in the email notifying the contractor of the payment.
purposestring required The purpose for this payment. Allowed purpose types are mentioned below, please refer.
amountfloat [upto 2 decimal place] required The gross amount to be paid including TDS, but not including GST, VAT, sales tax etc.
taxfloat [upto 2 decimal place] required The amount of GST, VAT, sales tax etc. for this payment
repeat_paymentstring optional The types of repeating payments are mentioned below, please refer. This field is required if the payment is to be repeated. If not, for a single payment, this field may be null.
invoice_datestring optional Date of Invoice. This is used to calculate the date of TDS payment (if any). Invoice date will be ignored in case of recurring payments. Date in format dd-mm-yyyy .
This field is required if the payment is a single payment and not repeated.
\n
Valid Purpose Values
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PurposeTDSTax CodeValue
Professional Services10%194Jprofessional-services
Technical Services2%194Jtechnical-services
Commission/Brokerage5%194Hcommission
Interest10%194Ainterest
Contractor - Resident Individual or HUF1%194Ccontractor-ind
Contractor - Others2%194Ccontractor-other
Rent of land/ building/ furniture/ fitting10%194Irent-land
Rent of plant and machinery2%194Irent-plan
Reimbursement / No TDS0%reimb-no-tds
\n

Valid Repeat Payment Values

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Value
repeat-weekly
repeat-monthly
repeat-quarterly
repeat-biannually
\n

In case of error:

\n
{\n    \"error_code\": {error_code},              //string\n    \"error_description\": {error_description} //string\n}\n\n

Possible error codes:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error codeDetails
UNAUTHORIZEDYou are not authorized to perform this action
USER_NOT_FOUNDNo user found from given details
INVALID_DATAInvalid data is given, eg. invalid employee type
UNKNOWN_EXCEPTIONSome unknown exception occurred
PAYMENT_ALREADY_QUEUEDA payment of the same amount is already queued
PERMISSION_DENIEDYou do not have the permissions configured to perform this action
\n
","urlObject":{"path":["partner","api","v2","people","{{userOrgId}}","contractor-payment"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"39b130f3-a18f-4de9-befb-8d49366d12df","name":"Create","originalRequest":{"method":"POST","header":[{"key":"x-api-id","value":"{{x-api-id}}","type":"text","disabled":true},{"key":"x-api-key","value":"{{x-api-key}}","type":"text","disabled":true},{"key":"x-partner-key","value":"{{x-partner-key}}","type":"text"},{"key":"x-client-key","value":"{{x-client-key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"from_email_id","value":"sample.email@mailinator.com","type":"text"},{"key":"attachments[]","type":"file","src":"SDsPs0MLg/invoice.pdf"},{"key":"execute_on","value":"2022-09-01","type":"text"},{"key":"remarks","value":"Test Payment","type":"text"},{"key":"purpose","value":"professional-services","type":"text"},{"key":"amount","value":"100","type":"text"},{"key":"tax","value":"5","type":"text"},{"key":"repeat_payment","value":"repeat-monthly","type":"text"},{"key":"invoice_date","value":"2022-09-01","type":"text"}]},"url":"{{base}}/partner/api/v2/people/{{userOrgId}}/contractor-payment"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"payment_id\": 1234,\n \"organization_id\": 1234,\n \"execution_date\": \"01 September, 2022\",\n \"remarks\": \"Test Payment\",\n \"purpose\": \"professional-services\",\n \"amount\": 100,\n \"tax\": 5,\n \"repeat_payment\": \"Repeat Monthly\",\n \"attachments\": [\n \"invoice.pdf\"\n ],\n \"invoice_date\": null,\n \"is_paid\": null\n}"}],"_postman_id":"6ba3f59c-b4e4-4258-9173-3e5ed9a86888"},{"name":"Delete","id":"fb2def54-e361-4c55-b33b-445b10fc19e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-partner-key","value":"{{x-partner-key}}","type":"text"},{"key":"x-client-key","value":"{{x-client-key}}","type":"text"}],"url":"{{base}}/partner/api/v2/people/contractor-payment/{{paymentId}}","description":"

Delete a contractor payment

\n

URL Param Description

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
ParamDescription
{{paymentId}}The payment ID of the contractor payment to be deleted.
\n

In case of error:

\n
{\n    \"error_code\": {error_code},              //string\n    \"error_description\": {error_description} //string\n}\n\n

Possible error codes:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error codeDetails
UNAUTHORIZEDYou are not authorized to perform this action
USER_NOT_FOUNDNo user found from given details
INVALID_DATAInvalid data is given, eg. invalid employee type
UNKNOWN_EXCEPTIONSome unknown exception occurred
PAYMENT_NOT_FOUNDA payment with this ID does not exist or has already been processed
PERMISSION_DENIEDYou do not have the permissions configured to perform this action
\n
","urlObject":{"path":["partner","api","v2","people","contractor-payment","{{paymentId}}"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"9fd4a6f6-2239-4e99-ae81-b41f413ba1fd","name":"Delete","originalRequest":{"method":"DELETE","header":[{"key":"x-api-id","value":"{{x-api-id}}","type":"text"},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"},{"key":"x-partner-key","value":"{{x-partner-key}}","type":"text"},{"key":"x-client-key","value":"{{x-client-key}}","type":"text"}],"url":"{{base}}/partner/api/v2/people/contractor-payment/{{paymentId}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"payment_id\": 1234,\n \"organization_id\": 1234,\n \"execution_date\": \"01 September, 2022\",\n \"remarks\": \"Test Payment\",\n \"purpose\": \"professional-services\",\n \"amount\": \"100\",\n \"tax\": \"5\",\n \"repeat_payment\": \"Repeat Monthly\",\n \"attachments\": \"{invoice.pdf}\",\n \"invoice_date\": null,\n \"is_paid\": false\n}"}],"_postman_id":"fb2def54-e361-4c55-b33b-445b10fc19e7"}],"id":"653c3114-ce6c-4eb9-9ae3-fc1c5d017e69","_postman_id":"653c3114-ce6c-4eb9-9ae3-fc1c5d017e69","description":""}]}