Get An Employee Compliance

GET https://payrollservice-d5ffb79ba43a9141.onporter.run/api/v1/payroll/compliance/employee

/compliance/employee

Retrieve Pay As You Earn (PAYE), Micro pension, and Pension compliance information for a specific employee of your company.

Input Schema

JSON

{
	employeeId: String
}

Response Schema

JSON

{
  status: Boolean,
  message: String,
  data: {
    paye: {
      employeeId: String,
      firstName: String,
      lastName: String,
      paye: {
        stateForPaye: String,
        taxId: String,
        amount: Number,
        manually_inputted: Boolean,
        createdAt: String (ISO 8601 Date String),
        updatedAt: String (ISO 8601 Date String)
      }
    },
    pension: {
      employeeId: String,
      firstName: String,
      lastName: String,
      pension: {
        provider: String,
        amount: Number,
        providerPin: String,
        usePercentage: Boolean,
        employeePensionPin: String,
        employerPensionContribution: Number,
        employeePensionContribution: Number,
        employerVoluntaryContribution: Number,
        employeeVoluntaryContribution: Number,
        manuallyInputted: Boolean,
        createdAt: String (ISO 8601 Date String),
        updatedAt: String (ISO 8601 Date String)
      }
    },
    microPension: {
      employeeId: String,
      firstName: String,
      lastName: String,
      microPension: {
        rate: Number,
        amount: Number,
        monthlyGrossAmount: Number,
        createdAt: String (ISO 8601 Date String),
        updatedAt: String (ISO 8601 Date String)
      }
    }
  }
}