PayRun

  • createdAt
    Type: stringFormat: date-time
    required

    When PayrollKit opened the Pay Run.

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

    PayrollKit Pay Run ID used in later API paths.

  • inputRevision
    Type: string
    required

    Current revision of the complete Pay Run inputs. This is the unquoted value returned as the ETag by Get Pay Run inputs.

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

    Pay Period processed by this Pay Run.

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

    Payroll Event containing this original Pay Run and any future corrective Pay Runs.

  • payRunType
    enum
    const:  
    original
    required

    original for the scheduled Pay Run. Corrective Pay Runs are not supported in this version.

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

    Pay Schedule that opened this Pay Run.

  • periodEndDate
    Type: stringFormat: date
    required

    Final calendar date included in the Pay Period.

  • periodStartDate
    Type: stringFormat: date
    required

    First calendar date included in the Pay Period.

  • plannedPaymentDate
    Type: stringFormat: date
    required

    Date wages are expected to be available after applying the Pay Schedule's non-banking-day rule.

  • reportedPaymentDate
    Type: stringFormat: date
    required

    Payment date used for payroll calculations and HMRC reporting. This may remain the usual payday when wages are planned for an adjacent banking day.

  • reportedPaymentDateReason
    Type: "usual_payday" or "usual_payday_non_banking_day_paid_on_preceding_banking_day" or "usual_payday_non_banking_day_paid_on_following_banking_day"enum
    required

    Why PayrollKit selected the reported and planned payment dates.

  • status
    Type: stringenum
    required

    Lifecycle state. draft accepts input changes, calculating has unfinished calculation work, calculated has a completed result awaiting approval, and approved is final. Use Pay Run checks for detailed readiness.

    values
    draftcalculatingcalculatedapproved
  • approvedAt
    Type: stringFormat: date-time

    When the Pay Run was approved. Present only after approval.

  • approvedBy
    Type: object

    Employer user who approved the Pay Run. Present only after approval.

    Properties: 2
  • approvedCalculationId
    Type: string

    Calculation approved for this Pay Run. Present only after approval.

  • currentCalculationId
    Type: string | null

    Latest Calculation for the current input revision, or null until calculation starts. Replacing inputs makes an earlier Calculation no longer current.