EmploymentCreateRequest

  • employment
    Type: object
    required
    • startDate
      Type: stringFormat: date
      required

      First day of this Employment. It cannot be changed after registration.

    • endDate
      Type: stringFormat: date

      Final day of this Employment, when already known.

    • endReason
      Type: "EMPLOYEE_LEFT" or "DEATH"enum
    • payrollId
      Type: string
      min length:  
      1
      max length:  
      35

      Employer-assigned payroll identifier. Omit when not yet supplied and add it before payroll is calculated.

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

    Case-sensitive ID of the worker or employee in the Partner's product. It must be unique within the Employer, identifies the Person rather than a particular job and cannot be changed after registration.

  • pensionProfile
    Type: object
    required

    The facts about where the employee works that decide which workplace pension law applies. PayrollKit works out State Pension age from the date of birth and the relief-at-source tax region from the tax code, so neither is supplied. These facts cannot be changed after the Employment is created.

    Properties: 3
  • person
    Type: object
    required
    Properties: 9
  • bankAccount
    Type: object
    Properties: 4
  • directorNiMethod
    Type: object
    Properties: 2
  • directorship
    Type: object

    Director appointment facts already confirmed for the Person. The accepted value is returned on the Employment.

    Properties: 3
  • nationalInsuranceAssignment
    Type: object

    National Insurance category already confirmed for the Employment. Omit when not supplied; PayrollKit does not assume category A.

    Properties: 3
  • partnerEmploymentId
    Type: string
    min length:  
    1
    max length:  
    200

    Case-sensitive ID of a separate job or employment record in the Partner's product. When supplied, it must be unique within the Employer and cannot be changed after registration. Omit it when the Partner has only a worker or employee record.

  • payScheduleMembership
    Type: object

    Explicit Pay Schedule assignment known when the Employment is created. Omit it when the assignment has not been confirmed. PayrollKit leaves the Employment incomplete even when the Employer has only one Pay Schedule.

    Properties: 2
  • pensionMembership
    Type: object
    Properties: 7
  • starterDetails

    P45 or starter-checklist information already confirmed for this Employment. The accepted value is returned on the Employment.

    P45 or starter-checklist information already confirmed for this Employment. The accepted value is returned on the Employment.

    • type
      Discriminator
      const:  
      current_year_p45
      required
    • leavingDate
      Type: stringFormat: date
      required

      Date the employee left the previous employment, as shown on the P45.

    • 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

    • studentLoanDeductionsContinue
      Type: boolean
      required

      Whether the P45 says student loan deductions should continue. A true value still needs the employee to confirm their plan before PayrollKit can deduct.

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

      week_1_month_1 when the P45 marks the code as week 1/month 1; otherwise cumulative.

    • taxCode
      Type: string
      required

      Tax code shown on the P45 at leaving, without spaces. Include an S or C prefix when the P45 shows one.

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

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

    • previousEmploymentPayPence
      Type: integer
      min:  
      0
      max:  
      999999999999

      Total pay to date shown on the P45. Required when taxBasis is cumulative; omit it for week_1_month_1.

    • previousEmploymentTaxPence
      Type: integer
      min:  
      -999999999999
      max:  
      999999999999

      Total tax to date shown on the P45, negative when it shows a refund. Required when taxBasis is cumulative; omit it for week_1_month_1.

  • studentLoanInstructions
    Type: array …2

    Student and postgraduate loan instructions known when the Employment is created. Omit when they have not been supplied. Send an empty array only when the Partner has confirmed that no current instruction applies. Send no more than one student-loan and one postgraduate-loan instruction.

  • taxInstruction
    Type: object

    Tax code and basis already confirmed for the Employment. Omit when not supplied; PayrollKit does not choose a default tax code.

    Properties: 5