Get All Employees Compliance

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

/compliance

Get All Employees Compliance. This endpoint allows you to retrieve compliance information related to Pay As You Earn (PAYE), Micro Pension, and Pension for all employees in your company.

Response Schema

{
  status: Boolean,
  message: String,
  data: {
    paye: {
      employees: [
        {
          employeeId: String,
          firstName: String,
          lastName: String,
          paye: {
            stateForPaye: String,
            taxId: String,
            amount: Number,
            manually_inputted: Boolean,
            createdAt: String,
            updatedAt: String,
          },
        },
        // ... (similar structure for other employees)
      ],
      employeeCount: Number,
      totalAmount: Number,
    },
    pension: {
      employees: [
        {
          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,
            updatedAt: String,
          },
        },
        // ... (similar structure for other employees)
      ],
      employeeCount: Number,
      totalAmount: Number,
    },
    micropension: {
      employees: [
        {
          employeeId: String,
          firstName: String,
          lastName: String,
          microPension: {
            rate: Number,
            amount: Number,
            monthlyGrossAmount: Number,
            createdAt: String,
            updatedAt: String,
          },
        },
        // ... (similar structure for other employees)
      ],
      employeeCount: Number,
      totalAmount: Number,
    },
  },
}
Headers
string

Bearer {your_api_key}

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json