Skip to main content

Payslip

Description​

A payslip is a document issued by an employer to an employee, detailing the breakdown of their earnings for a particular pay period. It outlines gross pay, net pay, any deductions such as taxes and pension contributions, and additional earnings like overtime, bonuses, or allowances.

Schema Information​

{
  "type": "object",
  "title": "Payslip",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "employeeName",
    "payPeriod",
    "netPay",
    "grossPay",
    "deductions",
    "earnings"
  ],
  "properties": {
    "netPay": {
      "type": "number"
    },
    "earnings": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/payslipItem"
      }
    },
    "grossPay": {
      "type": "number"
    },
    "birthDate": {
      "type": "string",
      "format": "date"
    },
    "payPeriod": {
      "type": "string"
    },
    "deductions": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/payslipItem"
      }
    },
    "paymentDate": {
      "type": "string",
      "format": "date"
    },
    "employeeName": {
      "type": "string"
    },
    "cumulativeInfo": {
      "type": "object",
      "properties": {
        "cumulativeEarnings": {
          "type": "number"
        },
        "cumulativeDeductions": {
          "type": "number"
        }
      }
    },
    "bankAccountNumber": {
      "type": "string"
    },
    "employmentStartDate": {
      "type": "string",
      "format": "date"
    },
    "lineItems": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "itemName",
          "amount"
        ],
        "properties": {
          "rate": {
            "type": "number",
            "default": 0
          },
          "type": {
            "enum": [
              "Earning",
              "Deduction"
            ],
            "type": "string"
          },
          "amount": {
            "type": "number"
          },
          "period": {
            "type": "string"
          },
          "itemName": {
            "type": "string"
          },
          "quantity": {
            "type": "number",
            "default": 0
          }
        },
        "additionalProperties": false
      }
    }
  },
  "definitions": {
    "payslipItem": {
      "type": "object",
      "required": [
        "itemName",
        "amount"
      ],
      "properties": {
        "rate": {
          "type": "number",
          "default": 0
        },
        "amount": {
          "type": "number"
        },
        "period": {
          "type": "string"
        },
        "itemName": {
          "type": "string"
        }
      }
    }
  },
  "additionalProperties": false
}