StarterChecklistDetails

  • declarationDate
    Type: stringFormat: date
    required

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

  • loanAnswers
    Type: object
    required

    The employee's answers to the starter checklist's student loan questions:

    • hasLoan: false when they have no student or postgraduate loan to repay.
    • repaymentExclusionApplies: true when they have a loan but a listed exclusion means deductions do not start, such as repaying HMRC directly by direct debit.
    • Otherwise repaymentExclusionApplies: false with the student loan plans they hold and whether they have a postgraduate loan. Supply at least one plan, a postgraduate loan, or both.
    Properties: 4
  • receivedAt
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • starterStatement
    Type: "a" or "b" or "c"enum
    required
  • type
    const:  
    starter_checklist
    required
  • partnerSourceId
    Type: string
    min length:  
    1
    max length:  
    200

    ID of a separate supporting record in the Partner's product.