EmploymentInstruction

  • createdAt
    Type: stringFormat: date-time
    required

    Time at which PayrollKit accepted and stored this instruction.

  • employmentId
    Type: string
    min length:  
    1
    max length:  
    200
    required

    PayrollKit Employment ID that owns this instruction.

  • id
    Type: string
    min length:  
    1
    max length:  
    200
    required

    PayrollKit Payroll Instruction ID.

  • instruction
    required

    Accepted instruction values for the stated instruction family.

    Accepted instruction values for the stated instruction family.

    • appliesFromDate
      Type: stringFormat: date
      required

      First date on which this Tax Instruction may be selected for payroll.

    • basis
      Type: "cumulative" or "week_1_month_1"enum
      required

      PAYE basis. cumulative uses tax-year pay and tax to date; week_1_month_1 calculates each payment without using earlier pay-period values.

    • code
      Type: string
      min length:  
      1
      max length:  
      12
      required

      Complete HMRC tax code for this Employment. Include an S or C prefix when HMRC has supplied one; the prefix selects Scottish or Welsh PAYE rates.

    • 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.

  • type
    Type: stringenum
    required

    Instruction family. Use this value to interpret the instruction object; loan records use their inner type to distinguish Student and Postgraduate Loan starts and stops.

    values
    taxnational_insurancedirector_ni_methodloanpension_membership