Home
Home
  1. Deduction Instructions
  • Salary Deduction
    • Welcome
    • Getting started
      • Availability and Onboarding
        • Light Availability Check
        • Full Availability Check
        • Onboarding
      • Salary Deduction
        • Deduction Instruction
        • Re-running Payroll
        • Deduction Payments and Reconciliation
        • Changes to Employee Status
    • API Reference
      • Authentication
      • Idempotency
      • Webhooks
        • Webhooks
      • Salary Deduction
        • Salary Deduction Data Request
        • Salary Deduction Confirmation Submission
    • Schemas
      • Availability Check
        • Light Availability Check Response
        • Light Availability Check Request
        • Full Availability Check Response
        • Full Availability Check Request
      • Core
        • ProblemDetails
      • Deduction Instructions
        • Salary Deduction
        • Confirmation Deduction Response
        • Salary Deduction Enablement Response
        • Employee Deduction Push Response
        • Employee Deduction Push Request
        • Latest Employee Deduction Push Response
      • Payment Account
        • Payment Account
        • Payment Information
      • Payroll
        • Salary Deduction Confirmation Data Submission
        • Salary Deduction Data Response
        • Payroll
        • Employee Payroll
        • Employment
        • Pay Date
        • Salary Deduction Enablement Request
      • Webhooks
        • Employee Update Payload
        • WebHook
  • Payroll Provider API Prototypes
    • Light Availability Check
      POST
    • Full Availability Check
      POST
    • Salary Deduction Enablement
      POST
    • Payroll Information
      GET
    • Salary Deduction Employee Data Push
      POST
    • Latest Salary Deduction Employee Data Push
      GET
  1. Deduction Instructions

Salary Deduction Enablement Response

Whether salary deduction was enabled, and the employee's employments.

{
    "salary_deduction_enablement_response": {
        "status": "accepted",
        "additional_information": {
            "reason": "string"
        },
        "employment": [
            {
                "employment": {
                    "employee_id": "string",
                    "start_date": "2019-08-24",
                    "currency": "GBP",
                    "employer": {
                        "id": "string",
                        "name": "string",
                        "registration_number": "string",
                        "sic_code": "string",
                        "industry_name": "string"
                    },
                    "payrolls": [
                        {
                            "payroll": {
                                "id": "string",
                                "employment_status": "unknown",
                                "contract_type": "unknown",
                                "payment_run_frequency": "unknown",
                                "annualised_salary": 0,
                                "pay_dates": [
                                    {
                                        "pay_date": "2019-08-24",
                                        "payroll_cutoff": "2019-08-24",
                                        "pay_period": "string"
                                    }
                                ]
                            }
                        }
                    ]
                }
            }
        ]
    }
}