get
https://payrollservice-d5ffb79ba43a9141.onporter.run/api/v1/payroll/calculate
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
/calculate
Calculate payroll based on provided input parameters. This endpoint allows you to simulate payroll calculations for a given set of employee and financial details. It also sends the calculated payroll to your email address for further analysis.
Input Schema
{
title: String,
usePercentageForAllowance: Boolean,
grossAmount: Number,
withholdingTax: Boolean,
paye: {
stateForPaye: String,
taxId: String,
amount: Number,
manually_inputted: Boolean,
},
pension: {
provider: String,
amount: Number,
providerPin: String,
usePercentage: Boolean,
employeePensionPin: String,
employerPensionContribution: Number,
employeePensionContribution: Number,
employerVoluntaryContribution: Number,
employeeVoluntaryContribution: Number,
manually_inputted: Boolean,
},
microPension: {
rate: Number,
amount: Number,
monthlyGrossAmount: Number,
},
allowanceDetails: [{
allowanceId: String,
percentage: Number,
amount: Number,
name: String,
}],
benefits: String[],
firstName: String,
email: String,
}
Response Schema
{
status: Boolean,
message: String,
data: {
annualGross: Number,
annualNet: Number,
annualEmployerPensionContribution: Number,
annualStatutories: {
annual_paye: Number,
annual_pension: Number,
annual_microPension: Number,
},
allowances: {
[allowanceName: String]: {
allowanceId: String,
percentage: Number,
amount: Number,
name: String,
},
};
};
}