PayRunChecks

  • expectedEmploymentIds
    Type: array of string unique!
    min length:  
    1
    max length:  
    200
    required

    Employments assigned to this Pay Run's schedule by the period end date whose employment dates overlap the period. Incomplete setup does not remove an Employment from this list.

  • issues
    Type: array of object
    required

    Current blockers and their next actions. An empty array means no known issue blocks the action represented by status.

    Properties: 9
  • payRunId
    Type: string
    min length:  
    1
    max length:  
    200
    required
  • status
    Type: stringenum
    required

    Readiness state for the next action. needs_setup requires Employer or Employment setup, needs_inputs requires complete Pay Run inputs, ready_to_calculate can be calculated, calculation_blocked has calculation or review issues, ready_to_approve has a reviewable result, and approved is final.

    values
    needs_setupneeds_inputsready_to_calculatecalculation_blockedready_to_approveapproved