LoanInstruction

    • type
      Discriminator
      Type: "student_loan_start" or "student_loan_stop"enum
      required

      Whether deductions for the supplied plan start or stop.

    • appliesFromPaymentDate
      Type: stringFormat: date
      required

      First payment date on which PayrollKit applies this instruction.

    • plan
      Type: stringenum
      required

      Student Loan plan affected by this instruction. It is required for both start and stop instructions.

      values
      plan_1plan_2plan_4plan_5
    • receivedAt
      Type: stringFormat: date-time
      required

      Time at which the Employer or Partner received the instruction.

    • sourceIssuedDate
      Type: stringFormat: date
      required

      Date shown on the source document or notice.

    • partnerSourceId
      Type: string
      min length:  
      1
      max length:  
      200

      ID of a separate supporting record in the Partner's product, such as an HMRC notice.