Employment

  • bankAccount
    Type: objectnullable
    required
    Properties: 5
  • createdAt
    Type: stringFormat: date-time
    required

    When PayrollKit created the Employment.

  • directorship
    Type: objectnullable
    required

    Accepted director appointment facts, or null when the Person is not recorded as a director.

    Properties: 3
  • endDate
    Type: string | nullFormat: date
    required

    Final day of the Employment, or null while it has no recorded end date.

  • endReason
    Type: "EMPLOYEE_LEFT" or "DEATH"enumnullable
    required

    Reason for the recorded end date, or null while it has no recorded end date.

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

    PayrollKit Employment ID.

  • partnerEmploymentId
    Type: string
    min length:  
    1
    max length:  
    200    nullable
    required

    ID of the matching job or employment record in the Partner's product, or null when the Partner has no separate record.

  • payrollId
    Type: string | null
    required

    Employer-assigned payroll identifier, or null until assigned. Once assigned, it cannot be replaced.

  • payScheduleMembership
    Type: objectnullable
    required

    Confirmed Pay Schedule assignment, or null until the Partner or Employer supplies one. PayrollKit does not infer the only Pay Schedule.

    Properties: 6
  • pensionProfile
    Type: object
    required

    Workplace pension facts accepted when the Employment was created.

    Properties: 3
  • person
    Type: object
    required

    Person who holds this Employment.

    Properties: 11
  • revision
    Type: string
    required

    Current opaque revision returned in the ETag header.

  • setupIssues
    Type: array of object
    required

    Missing or invalid setup information that must be resolved before the affected payroll step.

    Properties: 9
  • setupStatus
    Type: "incomplete" or "ready"enum
    required

    Whether all information needed to calculate payroll for this Employment has been supplied.

  • startDate
    Type: stringFormat: date
    required

    First day of the Employment. This value cannot be changed.

  • starterDetails
    nullable
    required

    Accepted P45 or starter-checklist basis, or null when none has been supplied.

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

    • type
      const:  
      current_year_p45
      required
    • 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.