Issue

  • blockedStep
    Type: stringenum
    required

    Request or payroll step that PayrollKit could not continue. Use code to choose the exact recovery path.

    values
    requestemployer_setupemployment_setupinput_updatesnapshotcalculationapprovalfilingpayslipexportpayment_instruction_filenew_intent
  • code
    Type: string
    required

    Stable machine-readable code for this issue. Use it to choose the recovery path.

  • message
    Type: string
    required

    Human-readable explanation of the issue. Use code for program behaviour.

  • nextAction
    Type: string
    required

    Human-readable action for your application or the Employer. Display or record this text and use code for program behaviour.

  • currentRevision
    Type: string

    Current resource revision when the supplied revision is stale.

  • currentStatus
    Type: string

    Current resource status when it explains why the requested action is unavailable.

  • fieldPath
    Type: string

    JSON Pointer for the affected field.

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

    PayrollKit ID of the affected resource.

  • resourceType
    Type: string

    Type of PayrollKit resource affected by this issue.