Home
Home
  1. Deduction Instructions
  • 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
  • Payroll Provider Reference Implementation
    • Light Availability Check
      POST
    • Full Availability Check
      POST
    • Salary Deduction Enablement
      POST
    • Payroll Information
      GET
    • Salary Deduction Employee Data Push
      POST
  • Schemas
    • Availability Check
      • Full Availability Check Request
      • Full Availability Check Response
      • Light Availability Check Request
      • Light Availability Check Response
    • Core
      • ProblemDetails
      • MetaData
      • Paged Response
    • Deduction Instructions
      • Salary Deduction Request
      • Salary Deduction
      • Confirmation Deduction Response
      • Salary Deduction Enablement Response
      • Employee Deduction Push Response
      • Employee Deduction Push Request
      • Salary Deduction Push
      • InstructionFile
      • InstructionItem
    • Payment Account
      • Payment Account
      • Payment Information
    • Payroll
      • Employee
      • Availability Payroll
      • Availability Employment
      • Availability Employer
      • BeneficiaryAccountResponse
      • Salary Deduction Confirmation Data Submission
      • Salary Deduction Confirmation Data Submission Response
      • Salary Deduction Data Request
      • Salary Deduction Data Response
      • Payroll
      • Employee Payroll
      • Employment
      • Employer
      • Pay Date
      • Salary Deduction Enablement Request
      • PayrollScheduleResponse
    • Webhooks
      • Employee Update Payload
      • WebHook
  1. Deduction Instructions

Salary Deduction Enablement Response

{
    "salary_deduction_enablement_response": {
        "result_code": "EmployeeHasLeft",
        "result_description": "string",
        "enabled_employments": [
            {
                "employment": {
                    "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
                    "start_date": "2019-08-24",
                    "currency": "GBP",
                    "employer": {
                        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                        "name": "string",
                        "registration_number": "string",
                        "sic_code": "string",
                        "industry_name": "Ipsum Lorem Limited",
                        "salary_deduction_opt_in_status": "Unknown"
                    },
                    "payrolls": [
                        {
                            "payroll": {
                                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                                "contract_type": "unknown",
                                "employment_status": "unknown",
                                "payment_run_frequency": "unknown",
                                "annualised_salary": 0,
                                "pay_dates": [
                                    {
                                        "pay_date": "2019-08-24",
                                        "payroll_cutoff_date": "2019-08-24",
                                        "pay_period": "string"
                                    }
                                ]
                            }
                        }
                    ]
                }
            }
        ]
    }
}