Skip to main content

Employee

Fetch Termination checklist for the employees

GET

Summary

Get termination checklist when terminating an employee

Description

API to Get termination checklist.

Responses
CodeDescriptionSchema
200Termination checklist has been fetched successfully.CheckListDto
401Unauthorized
403Forbidden
404Not Found

"

Request URL
https://bifrost-us.deskera.com/v1/people/employees/check-list
Curl
curl -X GET "https://bifrost-us.deskera.com/v1/people/employees/check-list" -H "accept: application/json" -H "x-access-token: sampletoken"
Sample Request

Sample Response
[
{
"seq": 1,
"item": "Submit Company Assets",
"id": null
},
{
"seq": 2,
"item": "Complete Exit Interview Process",
"id": null
},
{
"seq": 3,
"item": "Complete Knowledge Transfer",
"id": null
}
]
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Save termination checklist

Description

API to Save termination checklist

Parameters
NameLocated inDescriptionRequiredSchema
checkListDtosbodyTermination Detail JsonNo[ CheckListDto ]
Responses
CodeDescriptionSchema
200Termination checklist has been saved successfully.CheckListDto
201Created
401Unauthorized
403Forbidden
404Not Found

"

Request URL
https://bifrost-us.deskera.com/v1/people/employees/check-list
Curl
curl -X POST "https://bifrost-us.deskera.com/v1/people/employees/check-list" -H "accept: application/json" -H "x-access-token: sampletoken" -H "Content-Type: application/json" -d "[ { \"item\": \"This is task\", \"seq\": 1 }]"
Sample Request
[
{
"item": "This is task",
"seq": 1
}
]
Sample Response
[
{
"seq": 1,
"item": "This is task",
"id": 3944
}
]
Security
Security SchemaScopes
Authorizationglobal

Tax declarations

GET

Summary

Get Employee Tax Information Details.

Description

API to get employee tax declaration details.

Parameters
NameLocated inDescriptionRequiredSchema
financialYearStartDatequeryfinancialYearStartDateYesstring
stagequerystageYesstring
userIdqueryuserIdYesstring
Responses
CodeDescriptionSchema
200Employee tax declaration details has been fetched successfully.EmployeeTaxDeclarationResponseDto
401Unauthorized
403Forbidden
404Not Found

"

Request URL
https://bifrost-us.deskera.com/v1/people/employees/in/tax-declaration-info?financialYearStartDate=2022-04-01&stage=DECLARATION&userId=61fa1545b01be61555b31b6b
Curl
curl -X GET "https://bifrost-us.deskera.com/v1/people/employees/in/tax-declaration-info?financialYearStartDate=2022-04-01&stage=DECLARATION&userId=61fa1545b01be61555b31b6b" -H "accept: application/json" -H "x-access-token: sampletoken"
Sample Request

Sample Response
{
"employeeName": "John Doe",
"homeLoanRepayment": [
{
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
],
"lenderName": "Deskera",
"lenderPAN": "AB123456Z"
}
],
"houseRents": [
{
"address": {
"addressLine1": "218, Robinson Road",
"addressLine2": "Downtown",
"addressLine3": "Downtown",
"city": "Pune",
"country": "IN",
"county": "Montgomery County",
"state": "MH",
"zipCode": 123456
},
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
],
"isMetroCity": true,
"landlordName": "Deskera",
"landlordPAN": "AB123456Z",
"rentalFromDate": "2021-04-01",
"rentalToDate": "2022-03-31"
}
],
"investment80C": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"investment80D": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"newRegime": true,
"otherExemptions": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]

Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Save Employee Information Details.

Description

API to save employee information details.

Parameters
NameLocated inDescriptionRequiredSchema
requestDtobodyEmployee Tax Declaration Detail JsonNoEmployeeTaxRequestDto
stagequerystageYesstring
statusquerystatusYesstring
Responses
CodeDescriptionSchema
200OKstring
201Employee tax declaration details has been saved successfully.string
401Unauthorized
403Forbidden
404Not Found

"

Request URL
https://bifrost-us.deskera.com/v1/people/employees/in/tax-declaration-info?stage=DECLARATION&status=DRAFT
Curl
curl -X POST "https://bifrost-us.deskera.com/v1/people/employees/in/tax-declaration-info?stage=DECLARATION&status=DRAFT" -H "accept: application/json" -H "x-access-token: sampletoken" -H "Content-Type: application/json" -d "{ \"homeLoanRepayment\": [ { \"amountDetails\": [ { \"approverComments\": [ \"string\" ], \"attachments\": [ \"string\" ], \"declaredAmount\": 2000, \"name\": \"Interest Paid\", \"status\": \"PENDING\", \"submitterComments\": [ \"string\" ] } ], \"lenderName\": \"Deskera\", \"lenderPAN\": \"AB123456Z\" } ], \"houseRents\": [ { \"address\": { \"addressLine1\": \"218, Robinson Road\", \"addressLine2\": \"Downtown\", \"addressLine3\": \"Downtown\", \"city\": \"Pune\", \"country\": \"IN\", \"county\": \"Montgomery County\", \"state\": \"MH\", \"zipCode\": 123456 }, \"amountDetails\": [ { \"approverComments\": [ \"string\" ], \"attachments\": [ \"string\" ], \"declaredAmount\": 2000, \"name\": \"Interest Paid\", \"status\": \"PENDING\", \"submitterComments\": [ \"string\" ] } ], \"isMetroCity\": true, \"landlordName\": \"Deskera\", \"landlordPAN\": \"AB123456Z\", \"rentalFromDate\": \"2021-04-01\", \"rentalToDate\": \"2022-03-31\" } ], \"investment80C\": { \"amountDetails\": [ { \"approverComments\": [ \"string\" ], \"attachments\": [ \"string\" ], \"declaredAmount\": 2000, \"name\": \"Interest Paid\", \"status\": \"PENDING\", \"submitterComments\": [ \"string\" ] } ] }, \"investment80D\": { \"amountDetails\": [ { \"approverComments\": [ \"string\" ], \"attachments\": [ \"string\" ], \"declaredAmount\": 2000, \"name\": \"Interest Paid\", \"status\": \"PENDING\", \"submitterComments\": [ \"string\" ] } ] }, \"newRegime\": true, \"otherExemptions\": { \"amountDetails\": [ { \"approverComments\": [ \"string\" ], \"attachments\": [ \"string\" ], \"declaredAmount\": 2000, \"name\": \"Interest Paid\", \"status\": \"PENDING\", \"submitterComments\": [ \"string\" ] } ] }, \"otherIncomeSources\": { \"amountDetails\": [ { \"approverComments\": [ \"string\" ], \"attachments\": [ \"string\" ], \"declaredAmount\": 2000, \"name\": \"Interest Paid\", \"status\": \"PENDING\", \"submitterComments\": [ \"string\" ] } ] }, \"rentalIncome\": [ { \"amountDetails\": [ { \"approverComments\": [ \"string\" ], \"attachments\": [ \"string\" ], \"declaredAmount\": 2000, \"name\": \"Interest Paid\", \"status\": \"PENDING\", \"submitterComments\": [ \"string\" ] } ], \"lenderName\": \"Deskera\", \"lenderPAN\": \"AB123456Z\", \"repayingHomeLoanForThisProperty\": true } ], \"userId\": 1234}"
Sample Request
{
"homeLoanRepayment": [
{
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
],
"lenderName": "Deskera",
"lenderPAN": "AB123456Z"
}
],
"houseRents": [
{
"address": {
"addressLine1": "218, Robinson Road",
"addressLine2": "Downtown",
"addressLine3": "Downtown",
"city": "Pune",
"country": "IN",
"county": "Montgomery County",
"state": "MH",
"zipCode": 123456
},
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
],
"isMetroCity": true,
"landlordName": "Deskera",
"landlordPAN": "AB123456Z",
"rentalFromDate": "2021-04-01",
"rentalToDate": "2022-03-31"
}
],
"investment80C": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"investment80D": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"newRegime": true,
"otherExemptions": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"otherIncomeSources": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"rentalIncome": [
{
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
],
"lenderName": "Deskera",
"lenderPAN": "AB123456Z",
"repayingHomeLoanForThisProperty": true
}
],
"userId": 1234
}
Sample Response
{
"userId": "1234",
"newRegime": true,
"investment80C": {
"amountDetails": [
{
"attachments": null,
"submitterComments": [
"string"
],
"approverComments": [
"string"
],
"status": "PENDING",
"name": "Interest Paid",
"declaredAmount": 2000
}
]
},
"investment80D": {
"amountDetails": [
{
"attachments": [
"string"
],
"submitterComments": [
"string"
],
"approverComments": [
"string"
],
"status": "PENDING",
"name": "Interest Paid",
"declaredAmount": 2000
}
]
},
"otherExemptions": {
"amountDetails": [
{
"attachments": null,
"submitterComments": [
"string"
],
"approverComments": [
"string"
],
"status": "PENDING",
"name": "Interest Paid",
"declaredAmount": 2000
}
]
},
"otherIncomeSources": {
"amountDetails": [
{
"attachments": null,
"submitterComments": [
"string"
],
"approverComments": [
"string"
],
"status": "PENDING",
"name": "Interest Paid",
"declaredAmount": 2000
}
]
},
"submitOn": "2022-10-28",
"submitBy": 229024,
"status": "DRAFT",
"employeeName": null,
"homeLoanRepayment": [
{
"lenderName": "Deskera",
"lenderPAN": "AB123456Z",
"amountDetails": [
{
"attachments": null,
"submitterComments": [
"string"
],
"approverComments": [
"string"
],
"status": "PENDING",
"name": "Interest Paid",
"declaredAmount": 2000
}
]
}
],
"rentalIncome": [
{
"amountDetails": [
{
"attachments": null,
"submitterComments": [
"string"
],
"approverComments": [
"string"
],
"status": "PENDING",
"name": "Interest Paid",
"declaredAmount": 2000
}
],
"repayingHomeLoanForThisProperty": true,
"lenderName": "Deskera",
"lenderPAN": "AB123456Z"
}
],
"houseRents": [
{
"amountDetails": [
{
"attachments": null,
"submitterComments": [
"string"
],
"approverComments": [
"string"
],
"status": "PENDING",
"name": "Interest Paid",
"declaredAmount": 2000
}
],
"rentalFromDate": "2021-04-01",
"rentalToDate": "2022-03-31",
"address": {
"country": "IN",
"state": "MH",
"city": "Pune",
"zipCode": "123456",
"county": null,
"addressLine1": "218, Robinson Road",
"addressLine2": "Downtown",
"addressLine3": "Downtown"
},
"landlordName": "Deskera",
"landlordPAN": "AB123456Z",
"isMetroCity": true
}
]
}
Security
Security SchemaScopes
Authorizationglobal

PUT

Summary

Update Employee Tax Declaration Details.

Description

API to update employee tax declaration details.

Parameters
NameLocated inDescriptionRequiredSchema
financialYearStartDatequeryfinancialYearStartDateYesstring
requestDtobodyEmployee Tax Declaration Detail JsonNoEmployeeTaxRequestDto
stagequerystageYesstring
statusquerystatusYesstring
Responses
CodeDescriptionSchema
200Employee tax declaration details has been updated successfully.EmployeeTaxDeclarationResponseDto
201Created
401Unauthorized
403Forbidden
404Not Found

"

Request URL
https://bifrost-us.deskera.com/v1/people/employees/in/tax-declaration-info?financialYearStartDate=2022-04-01&stage=DECLARATION&status=DRAFT
Curl
curl -X PUT "https://bifrost-us.deskera.com/v1/people/employees/in/tax-declaration-info?financialYearStartDate=2022-04-01&stage=DECLARATION&status=DRAFT" -H "accept: application/json" -H "x-access-token: sampletoken" -H "Content-Type: application/json" -d "{ \"homeLoanRepayment\": [ { \"amountDetails\": [ { \"approverComments\": [ \"string\" ], \"attachments\": [ \"string\" ], \"declaredAmount\": 2000, \"name\": \"Interest Paid\", \"status\": \"PENDING\", \"submitterComments\": [ \"string\" ] } ], \"lenderName\": \"Deskera\", \"lenderPAN\": \"AB123456Z\" } ], \"houseRents\": [ { \"address\": { \"addressLine1\": \"218, Robinson Road\", \"addressLine2\": \"Downtown\", \"addressLine3\": \"Downtown\", \"city\": \"Pune\", \"country\": \"IN\", \"county\": \"Montgomery County\", \"state\": \"MH\", \"zipCode\": 123456 }, \"amountDetails\": [ { \"approverComments\": [ \"string\" ], \"attachments\": [ \"string\" ], \"declaredAmount\": 2000, \"name\": \"Interest Paid\", \"status\": \"PENDING\", \"submitterComments\": [ \"string\" ] } ], \"isMetroCity\": true, \"landlordName\": \"Deskera\", \"landlordPAN\": \"AB123456Z\", \"rentalFromDate\": \"2021-04-01\", \"rentalToDate\": \"2022-03-31\" } ], \"investment80C\": { \"amountDetails\": [ { \"approverComments\": [ \"string\" ], \"attachments\": [ \"string\" ], \"declaredAmount\": 2000, \"name\": \"Interest Paid\", \"status\": \"PENDING\", \"submitterComments\": [ \"string\" ] } ] }, \"investment80D\": { \"amountDetails\": [ { \"approverComments\": [ \"string\" ], \"attachments\": [ \"string\" ], \"declaredAmount\": 2000, \"name\": \"Interest Paid\", \"status\": \"PENDING\", \"submitterComments\": [ \"string\" ] } ] }, \"newRegime\": true, \"otherExemptions\": { \"amountDetails\": [ { \"approverComments\": [ \"string\" ], \"attachments\": [ \"string\" ], \"declaredAmount\": 2000, \"name\": \"Interest Paid\", \"status\": \"PENDING\", \"submitterComments\": [ \"string\" ] } ] }, \"otherIncomeSources\": { \"amountDetails\": [ { \"approverComments\": [ \"string\" ], \"attachments\": [ \"string\" ], \"declaredAmount\": 2000, \"name\": \"Interest Paid\", \"status\": \"PENDING\", \"submitterComments\": [ \"string\" ] } ] }, \"rentalIncome\": [ { \"amountDetails\": [ { \"approverComments\": [ \"string\" ], \"attachments\": [ \"string\" ], \"declaredAmount\": 2000, \"name\": \"Interest Paid\", \"status\": \"PENDING\", \"submitterComments\": [ \"string\" ] } ], \"lenderName\": \"Deskera\", \"lenderPAN\": \"AB123456Z\", \"repayingHomeLoanForThisProperty\": true } ], \"userId\": 1234}"
Sample Request
{
"userId": "1234",
"newRegime": true,
"investment80C": {
"amountDetails": [
{
"attachments": null,
"submitterComments": [
"string"
],
"approverComments": [
"string"
],
"status": "PENDING",
"name": "Interest Paid",
"declaredAmount": 2000
}
]
},
"investment80D": {
"amountDetails": [
{
"attachments": [
"string"
],
"submitterComments": [
"string"
],
"approverComments": [
"string"
],
"status": "PENDING",
"name": "Interest Paid",
"declaredAmount": 2000
}
]
},
"otherExemptions": {
"amountDetails": [
{
"attachments": null,
"submitterComments": [
"string"
],
"approverComments": [
"string"
],
"status": "PENDING",
"name": "Interest Paid",
"declaredAmount": 2000
}
]
},
"otherIncomeSources": {
"amountDetails": [
{
"attachments": null,
"submitterComments": [
"string"
],
"approverComments": [
"string"
],
"status": "PENDING",
"name": "Interest Paid",
"declaredAmount": 2000
}
]
},
"submitOn": "2022-10-28",
"submitBy": 229024,
"status": "DRAFT",
"employeeName": null,
"homeLoanRepayment": [
{
"lenderName": "Deskera",
"lenderPAN": "AB123456Z",
"amountDetails": [
{
"attachments": null,
"submitterComments": [
"string"
],
"approverComments": [
"string"
],
"status": "PENDING",
"name": "Interest Paid",
"declaredAmount": 2000
}
]
}
],
"rentalIncome": [
{
"amountDetails": [
{
"attachments": null,
"submitterComments": [
"string"
],
"approverComments": [
"string"
],
"status": "PENDING",
"name": "Interest Paid",
"declaredAmount": 2000
}
],
"repayingHomeLoanForThisProperty": true,
"lenderName": "Deskera",
"lenderPAN": "AB123456Z"
}
],
"houseRents": [
{
"amountDetails": [
{
"attachments": null,
"submitterComments": [
"string"
],
"approverComments": [
"string"
],
"status": "PENDING",
"name": "Interest Paid",
"declaredAmount": 2000
}
],
"rentalFromDate": "2021-04-01",
"rentalToDate": "2022-03-31",
"address": {
"country": "IN",
"state": "MH",
"city": "Pune",
"zipCode": "123456",
"county": null,
"addressLine1": "218, Robinson Road",
"addressLine2": "Downtown",
"addressLine3": "Downtown"
},
"landlordName": "Deskera",
"landlordPAN": "AB123456Z",
"isMetroCity": true
}
]
}
Sample Response
{
"employeeName": "John Doe",
"homeLoanRepayment": [
{
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
],
"lenderName": "Deskera",
"lenderPAN": "AB123456Z"
}
],
"houseRents": [
{
"address": {
"addressLine1": "218, Robinson Road",
"addressLine2": "Downtown",
"addressLine3": "Downtown",
"city": "Pune",
"country": "IN",
"county": "Montgomery County",
"state": "MH",
"zipCode": 123456
},
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
],
"isMetroCity": true,
"landlordName": "Deskera",
"landlordPAN": "AB123456Z",
"rentalFromDate": "2021-04-01",
"rentalToDate": "2022-03-31"
}
],
"investment80C": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"investment80D": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"newRegime": true,
"otherExemptions": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"otherIncomeSources": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"rentalIncome": [
{
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
],
"lenderName": "Deskera",
"lenderPAN": "AB123456Z",
"repayingHomeLoanForThisProperty": true
}
],
"status": "DRAFT",
"submitBy": 1234,
"submitOn": "2021-04-30",
"userId": 1234
}
Security
Security SchemaScopes
Authorizationglobal

Tax declaration details

GET

Summary

Get Employee Tax Information Details For All Stages.

Description

API to get employee tax declaration details for all stages

Parameters
NameLocated inDescriptionRequiredSchema
financialYearStartDatequeryfinancialYearStartDateYesstring
userIdqueryuserIdYesstring
Responses
CodeDescriptionSchema
200Employee tax declaration details has been fetched successfully.EmployeeTaxDeclarationDetails
401Unauthorized
403Forbidden
404Not Found

"

Request URL
https://bifrost-us.deskera.com/v1/people/employees/in/tax-declaration-info/details?financialYearStartDate=2022-04-01&userId=61fa1545b01be61555b31b6b
Curl
curl -X GET "https://bifrost-us.deskera.com/v1/people/employees/in/tax-declaration-info/details?financialYearStartDate=2022-04-01&userId=61fa1545b01be61555b31b6b" -H "accept: application/json" -H "x-access-token: sampletoken"
Sample Request

Sample Response
{
"actual": {
"employeeName": "John Doe",
"homeLoanRepayment": [
{
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
],
"lenderName": "Deskera",
"lenderPAN": "AB123456Z"
}
],
"houseRents": [
{
"address": {
"addressLine1": "218, Robinson Road",
"addressLine2": "Downtown",
"addressLine3": "Downtown",
"city": "Pune",
"country": "IN",
"county": "Montgomery County",
"state": "MH",
"zipCode": 123456
},
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
],
"isMetroCity": true,
"landlordName": "Deskera",
"landlordPAN": "AB123456Z",
"rentalFromDate": "2021-04-01",
"rentalToDate": "2022-03-31"
}
],
"investment80C": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"investment80D": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"newRegime": true,
"otherExemptions": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"otherIncomeSources": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"rentalIncome": [
{
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
],
"lenderName": "Deskera",
"lenderPAN": "AB123456Z",
"repayingHomeLoanForThisProperty": true
}
],
"status": "DRAFT",
"submitBy": 1234,
"submitOn": "2021-04-30",
"userId": 1234
},
"approved": {
"employeeName": "John Doe",
"homeLoanRepayment": [
{
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
],
"lenderName": "Deskera",
"lenderPAN": "AB123456Z"
}
],
"houseRents": [
{
"address": {
"addressLine1": "218, Robinson Road",
"addressLine2": "Downtown",
"addressLine3": "Downtown",
"city": "Pune",
"country": "IN",
"county": "Montgomery County",
"state": "MH",
"zipCode": 123456
},
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
],
"isMetroCity": true,
"landlordName": "Deskera",
"landlordPAN": "AB123456Z",
"rentalFromDate": "2021-04-01",
"rentalToDate": "2022-03-31"
}
],
"investment80C": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"investment80D": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"newRegime": true,
"otherExemptions": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"otherIncomeSources": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"rentalIncome": [
{
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
],
"lenderName": "Deskera",
"lenderPAN": "AB123456Z",
"repayingHomeLoanForThisProperty": true
}
],
"status": "DRAFT",
"submitBy": 1234,
"submitOn": "2021-04-30",
"userId": 1234
},
"declaration": {
"employeeName": "John Doe",
"homeLoanRepayment": [
{
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
],
"lenderName": "Deskera",
"lenderPAN": "AB123456Z"
}
],
"houseRents": [
{
"address": {
"addressLine1": "218, Robinson Road",
"addressLine2": "Downtown",
"addressLine3": "Downtown",
"city": "Pune",
"country": "IN",
"county": "Montgomery County",
"state": "MH",
"zipCode": 123456
},
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
],
"isMetroCity": true,
"landlordName": "Deskera",
"landlordPAN": "AB123456Z",
"rentalFromDate": "2021-04-01",
"rentalToDate": "2022-03-31"
}
],
"investment80C": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"investment80D": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"newRegime": true,
"otherExemptions": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"otherIncomeSources": {
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
]
},
"rentalIncome": [
{
"amountDetails": [
{
"approverComments": [
"string"
],
"attachments": [
"string"
],
"declaredAmount": 2000,
"name": "Interest Paid",
"status": "PENDING",
"submitterComments": [
"string"
]
}
],
"lenderName": "Deskera",
"lenderPAN": "AB123456Z",
"repayingHomeLoanForThisProperty": true
}
],
"status": "DRAFT",
"submitBy": 1234,
"submitOn": "2021-04-30",
"userId": 1234
}
}
Security
Security SchemaScopes
Authorizationglobal

Tax declaration infomration

POST

Summary

Api to get employee's investment submission details by user ids

Description

Api to get employee's investment submission details by user ids

Parameters
NameLocated inDescriptionRequiredSchema
stagequerystageYesstring
userIdsbodyuserIdsYes[ string ]
Responses
CodeDescriptionSchema
200Employees investment submission details has been fetched successfully.EmployeeTaxDeclarationInfo
201Created
401Unauthorized
403Forbidden
404Not Found

"

Request URL
https://bifrost-us.deskera.com/v1/people/employees/in/tax-declaration-info/info?stage=DECLARATION
Curl
curl -X POST "https://bifrost-us.deskera.com/v1/people/employees/in/tax-declaration-info/info?stage=DECLARATION" -H "accept: application/json" -H "x-access-token: sampletoken" -H "Content-Type: application/json" -d "[ \"61fa1545b01be61555b31b6b\"]"
Sample Request
[
"61fa1545b01be61555b31b6b"
]
Sample Response
{
"rejectedItems": "Income from other sources",
"stage": "DECLARATION",
"status": "DRAFT",
"submitOn": "2021-04-01",
"userId": 1234
}
Security
Security SchemaScopes
Authorizationglobal

Employee Termination

GET

Summary

Get Employee Termination Details.

Description

API to get employee termination details.

Parameters
NameLocated inDescriptionRequiredSchema
empIdqueryEmployee Termination Detail JsonNolong
Responses
CodeDescriptionSchema
200Employee termination details has been fetched successfully.TerminationEmployeeDetailsRequestDto
401Unauthorized
403Forbidden
404Not Found

"

Request URL
https://bifrost-us.deskera.com/v1/people/employees/termination?empId=50125
Curl
curl -X GET "https://bifrost-us.deskera.com/v1/people/employees/termination?empId=50125" -H "accept: application/json" -H "x-access-token: sampletoken"
Sample Request

Sample Response
{
"compliance": [
{
"fieldValue": "TRUE"
}
],
"employeeId": 1234,
"employeePersonalEmail": "employee@xyz.com",
"terminationDate": "20-09-2020",
"terminationReason": "Relocation",
"terminationType": "VOLUNTARY"
}
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Save Employee Termination Details.

Description

API to save employee termination details.

Parameters
NameLocated inDescriptionRequiredSchema
requestDtobodyEmployee Termination Detail JsonNoTerminationEmployeeDetailsRequestDto
Responses
CodeDescriptionSchema
200OKTerminationEmployeeDetailsRequestDto
201Employee termination details has been saved successfully.TerminationEmployeeDetailsRequestDto
401Unauthorized
403Forbidden
404Not Found

"

Request URL
https://bifrost-us.deskera.com/v1/people/employees/termination
Curl
curl -X POST "https://bifrost-us.deskera.com/v1/people/employees/termination" -H "accept: application/json" -H "x-access-token: sampletoken" -H "Content-Type: application/json" -d "{ \"compliance\": [ { \"fieldValue\": \"TRUE\" } ], \"employeeId\": 1234, \"employeePersonalEmail\": \"employee@xyz.com\", \"terminationDate\": \"20-09-2020\", \"terminationReason\": \"Relocation\", \"terminationType\": \"VOLUNTARY\"}"
Sample Request
{
"compliance": [
{
"fieldValue": "TRUE"
}
],
"employeeId": 1234,
"employeePersonalEmail": "employee@xyz.com",
"terminationDate": "20-09-2020",
"terminationReason": "Relocation",
"terminationType": "VOLUNTARY"
}
Sample Response
{
"compliance": [
{
"fieldValue": "TRUE"
}
],
"employeeId": 1234,
"employeePersonalEmail": "employee@xyz.com",
"terminationDate": "20-09-2020",
"terminationReason": "Relocation",
"terminationType": "VOLUNTARY"
}
Security
Security SchemaScopes
Authorizationglobal

PUT

Summary

Update Employee Termination Details.

Description

API to update employee termination details.

Parameters
NameLocated inDescriptionRequiredSchema
requestDtobodyEmployee Termination Detail JsonNoTerminationEmployeeDetailsRequestDto
Responses
CodeDescriptionSchema
200Employee termination details has been updated successfully.TerminationEmployeeDetailsRequestDto
201Created
401Unauthorized
403Forbidden
404Not Found

"

Request URL
https://bifrost-us.deskera.com/v1/people/employees/termination
Curl
curl -X POST "https://bifrost-us.deskera.com/v1/people/employees/termination" -H "accept: application/json" -H "x-access-token: sampletoken" -H "Content-Type: application/json" -d "{ \"compliance\": [ { \"fieldValue\": \"TRUE\" } ], \"employeeId\": 1234, \"employeePersonalEmail\": \"employee@xyz.com\", \"terminationDate\": \"20-09-2020\", \"terminationReason\": \"Relocation\", \"terminationType\": \"VOLUNTARY\"}"
Sample Request
{
"compliance": [
{
"fieldValue": "TRUE"
}
],
"employeeId": 1234,
"employeePersonalEmail": "employee@xyz.com",
"terminationDate": "20-09-2020",
"terminationReason": "Relocation",
"terminationType": "VOLUNTARY"
}
Sample Response
{
"compliance": [
{
"fieldValue": "TRUE"
}
],
"employeeId": 1234,
"employeePersonalEmail": "employee@xyz.com",
"terminationDate": "20-09-2020",
"terminationReason": "Relocation",
"terminationType": "VOLUNTARY"
}
Security
Security SchemaScopes
Authorizationglobal

Rehire Terminated Employees

GET

Summary

Update Employee Termination Details.

Description

API to update employee termination details.

Parameters
NameLocated inDescriptionRequiredSchema
userIdpathuserIdYeslong
Responses
CodeDescription
200Employee termination details has been updated successfully.
401Unauthorized
403Forbidden
404Not Found

"

Request URL
https://bifrost-us.deskera.com/v1/people/employees/termination/rehire/10123
Curl

curl -X GET "https://bifrost-us.deskera.com/v1/people/employees/termination/rehire/10123" -H "accept: application/json" -H "x-access-token: sampletoken"


Sample Request

Sample Response
Employee termination details has been updated successfully.
Security
Security SchemaScopes
Authorizationglobal

Manage Termination Checklist

GET

Summary

Get employee termination checklist.

Description

API to Get employee termination checklist.

Parameters
NameLocated inDescriptionRequiredSchema
empidpathempidYeslong
Responses
CodeDescriptionSchema
200Employee termination checklist has been fetched successfully.CheckListDto
401Unauthorized
403Forbidden
404Not Found

"

Request URL
https://bifrost-us.deskera.com/v1/people/employees/10241/check-list
Curl
curl -X GET "https://bifrost-us.deskera.com/v1/people/employees/10241/check-list" -H "accept: application/json" -H "x-access-token: sampletoken"
Sample Request

Sample Response
[
{
"seq": 1,
"item": "This is task",
"id": 3944,
"employeeItemStatus": false,
"managerItemStatus": false
}
]
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Save employee termination checklist

Description

API to Save employee termination checklist

Parameters
NameLocated inDescriptionRequiredSchema
empidpathempidYeslong
employeeCheckListDtoListbodyemployeeCheckListDtoListYes[ EmployeeCheckListDto ]
Responses
CodeDescriptionSchema
200Employee termination checklist has been saved successfully.CheckListDto
201Created
401Unauthorized
403Forbidden
404Not Found

"

Request URL
https://bifrost-us.deskera.com/v1/people/employees/01215/check-list
Curl
curl -X POST "https://bifrost-us.deskera.com/v1/people/employees/01215/check-list" -H "accept: application/json" -H "x-access-token: sampletoken" -H "Content-Type: application/json" -d "[ { \"employeeItemStatus\": false, \"id\": 0, \"item\": \"This is task\", \"managerItemStatus\": false, \"seq\": 1 }]"
Sample Request
[
{
"employeeItemStatus": false,
"id": 0,
"item": "This is task",
"managerItemStatus": false,
"seq": 1
}
]
Sample Response
[
{
"seq": 1,
"item": "This is task",
"id": 2159,
"employeeItemStatus": false,
"managerItemStatus": false
}
]
Security
Security SchemaScopes
Authorizationglobal

PUT

Summary

Update termination checklist status.

Description

API to Update termination checklist status.

Parameters
NameLocated inDescriptionRequiredSchema
CheckListStatusDtosbodyTermination Status JsonNo[ CheckListStatusDto ]
empidpathempidYeslong
selfqueryselfYesboolean
Responses
CodeDescriptionSchema
200Termination checklist status has been updated successfully.CheckListDto
201Created
401Unauthorized
403Forbidden
404Not Found

"

Request URL
https://bifrost-us.deskera.com/v1/people/employees/10251/check-list?self=true
Curl
curl -X PUT "http://localhost:8080/v1/people/employees/10251/check-list?self=true" -H "accept: application/json" -H "x-access-token: sampletoken" -H "Content-Type: application/json" -d "[ { \"employeeItemStatus\": false, \"id\": 0, \"item\": \"This is task\", \"managerItemStatus\": false, \"seq\": 1 }]"
Sample Request
[
{
"employeeItemStatus": false,
"id": 0,
"item": "This is task",
"managerItemStatus": false,
"seq": 1
}
]
Sample Response
{
"item": "This is task",
"seq": 1
}
Security
Security SchemaScopes
Authorizationglobal

PATCH

Summary

Update employee termination checklist

Description

API to Update employee termination checklist

Parameters
NameLocated inDescriptionRequiredSchema
empidpathempidYeslong
employeeCheckListDtoListbodyemployeeCheckListDtoListYes[ EmployeeCheckListDto ]
Responses
CodeDescriptionSchema
200Employee termination checklist has been updated successfully.CheckListDto
204No Content
401Unauthorized
403Forbidden

"

Request URL
https://bifrost-us.deskera.com/v1/people/employees/10245/check-list
Curl
curl -X PATCH "https://bifrost-us.deskera.com/v1/people/employees/10245/check-list" -H "accept: application/json" -H "x-access-token: sampletoken" -H "Content-Type: application/json" -d "[ { \"employeeItemStatus\": false, \"id\": 0, \"item\": \"This is task\", \"managerItemStatus\": false, \"seq\": 1 }]"
Sample Request
[
{
"employeeItemStatus": false,
"id": 0,
"item": "This is task",
"managerItemStatus": false,
"seq": 1
}
]
Sample Response
{
"item": "This is task",
"seq": 1
}
Security
Security SchemaScopes
Authorizationglobal

Models

AddressDto

NameTypeDescriptionRequired
addressLine1stringAddress line 1
Example: "218, Robinson Road"No
addressLine2stringAddress line 2
Example: "Downtown"No
addressLine3stringAddress line 3
Example: "Downtown"No
citystringCity
Example: "Pune"No
countrystringCountry
Example: "IN"No
countystringCounty
Example: "Montgomery County"No
statestringState
Example: "MH"No
zipCodestringPostal Code
Example: 123456No

AmountDetailsDTO

NameTypeDescriptionRequired
approverComments[ string ]No
attachments[ string ]No
declaredAmountnumberThis is amount declared against the particular
Example: 2000No
namestringThis is name of particular against which payment is done
Example: "Interest Paid"No
statusstringEnum: "PENDING", "APPROVED", "REJECTED"No
submitterComments[ string ]No

CheckListDto

NameTypeDescriptionRequired
itemstringTask
Example: "This is task"No
seqlongThis is task seq id
Example: 1No

CheckListResponseDto

NameTypeDescriptionRequired
idlongNo
itemstringTask
Example: "This is task"No
seqlongThis is task seq id
Example: 1No

CheckListStatusDto

NameTypeDescriptionRequired
employeeItemStatusbooleanThis is employee task status
Example: falseNo
idlongNo
itemstringTask
Example: "This is task"No
managerItemStatusbooleanThis is manager status
Example: falseNo
seqlongThis is task seq id
Example: 1No

EmployeeCheckListDto

NameTypeDescriptionRequired
employeeItemStatusbooleanThis is employee task status
Example: falseNo
idlongNo
itemstringTask
Example: "This is task"No
managerItemStatusbooleanThis is manager status
Example: falseNo
seqlongThis is task seq id
Example: 1No

EmployeeTaxDeclarationDetails

NameTypeDescriptionRequired
actualEmployeeTaxDeclarationResponseDtoNo
approvedEmployeeTaxDeclarationResponseDtoNo
declarationEmployeeTaxDeclarationResponseDtoNo

EmployeeTaxDeclarationInfo

NameTypeDescriptionRequired
rejectedItems[ string ]Rejected Items
Example: "Income from other sources"No
stagestringTax Declaration Stage

Enum: "DECLARATION", "ACTUAL", "APPROVED" Example: "DECLARATION" | No | | status | string | Tax Declaration Status Enum: "DRAFT", "SUBMITTED" Example: "DRAFT" | No | | submitOn | date | Tax Declaraion Date Example: "2021-04-01" | No | | userId | string | Employee User Id Example: 1234 | No |

EmployeeTaxDeclarationResponseDto

NameTypeDescriptionRequired
employeeNamestringEmployee Name
Example: "John Doe"No
homeLoanRepayment[ HomeLoanRepaymentRequest ]No
houseRents[ HouseRentRequest ]No
investment80CInvestment80CRequest80C Investments details object
Example: "80C Investments"No
investment80DInvestment80DRequest80D Investments details object
Example: "80D Investments"No
newRegimebooleanTrue if tax calculation is based on New Regime calculation
Example: trueNo
otherExemptionsOtherExemptionsRequestExemptions from other sources
Example: "Other Exemptions"No
otherIncomeSourcesOtherIncomeSourcesRequestIncome from other sources
Example: "Other Income sources"No
rentalIncome[ RentalIncomeRequest ]No
statusstringEmployee User Id

Enum: "DRAFT", "SUBMITTED" Example: "DRAFT" | No | | submitBy | long | Employee User Id Example: 1234 | No | | submitOn | date | Declaration Date Example: "2021-04-30" | No | | userId | string | Employee User Id Example: 1234 | No |

EmployeeTaxRequestDto

NameTypeDescriptionRequired
homeLoanRepayment[ HomeLoanRepaymentRequest ]No
houseRents[ HouseRentRequest ]No
investment80CInvestment80CRequest80C Investments details object
Example: "80C Investments"No
investment80DInvestment80DRequest80D Investments details object
Example: "80D Investments"No
newRegimebooleanTrue if tax calculation is based on New Regime calculation
Example: trueNo
otherExemptionsOtherExemptionsRequestExemptions from other sources
Example: "Other Exemptions"No
otherIncomeSourcesOtherIncomeSourcesRequestIncome from other sources
Example: "Other Income sources"No
rentalIncome[ RentalIncomeRequest ]No
userIdstringEmployee User Id
Example: 1234No

EmployeeTerminationCheckListResponse

NameTypeDescriptionRequired
employeeItemStatusbooleanThis is employee task status
Example: falseNo
idlongNo
itemstringTask
Example: "This is task"No
managerItemStatusbooleanThis is manager status
Example: falseNo
seqlongThis is task seq id
Example: 1No

HomeLoanRepaymentRequest

NameTypeDescriptionRequired
amountDetails[ AmountDetailsDTO ]No
lenderNamestringLender Name
Example: "Deskera"No
lenderPANstringLender PAN Number
Example: "AB123456Z"No

HouseRentRequest

NameTypeDescriptionRequired
addressAddressDtoNo
amountDetails[ AmountDetailsDTO ]No
isMetroCitybooleanNo
landlordNamestringLender Name
Example: "Deskera"No
landlordPANstringLender PAN Number
Example: "AB123456Z"No
rentalFromDatedateRental Start Date
Example: "2021-04-01"No
rentalToDatedateRental End Date
Example: "2022-03-31"No

Investment80CRequest

NameTypeDescriptionRequired
amountDetails[ AmountDetailsDTO ]No

Investment80DRequest

NameTypeDescriptionRequired
amountDetails[ AmountDetailsDTO ]No

OtherExemptionsRequest

NameTypeDescriptionRequired
amountDetails[ AmountDetailsDTO ]No

OtherIncomeSourcesRequest

NameTypeDescriptionRequired
amountDetails[ AmountDetailsDTO ]No

RentalIncomeRequest

NameTypeDescriptionRequired
amountDetails[ AmountDetailsDTO ]No
lenderNamestringLender Name
Example: "Deskera"No
lenderPANstringLender PAN Number
Example: "AB123456Z"No
repayingHomeLoanForThisPropertybooleanNo

TerminationEmployeeComplianceData

NameTypeDescriptionRequired
fieldValueobjectField Value
Example: "TRUE"No

TerminationEmployeeDetailsRequestDto

NameTypeDescriptionRequired
compliance[ TerminationEmployeeComplianceData ]List of compliance dataNo
employeeIdlongEmployee User Id
Example: 1234No
employeePersonalEmailstringEmployee Personal Email
Example: "employee@xyz.com"No
terminationDatedatedate pattern dd-MM-yyyy
Example: "20-09-2020"Yes
terminationReasonstringTermination Reason
Example: "Relocation"No
terminationTypestringTermination Type

Enum: "VOLUNTARY", "INVOLUNTARY" Example: "VOLUNTARY" | No |

TerminationEmployeeDetailsResponseDto

NameTypeDescriptionRequired
compliance[ TerminationEmployeeComplianceData ]List of compliance dataNo
employeeIdlongEmployee User Id
Example: 1234No
employeePersonalEmailstringEmployee Personal Email
Example: "employee@xyz.com"No
terminationDatedateTimedate pattern dd-MM-yyyy
Example: "20-09-2020"Yes
terminationReasonstringTermination Reason
Example: "Relocation"No
terminationTypestringTermination Type

Enum: "VOLUNTARY", "INVOLUNTARY" Example: "VOLUNTARY" | No |