Calculation

  • Type: object
    • createdAt
      Type: stringFormat: date-time
      required

      When PayrollKit created the Calculation.

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

      PayrollKit Calculation ID.

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

      Pay Run being calculated.

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

      Fixed Snapshot used for this Calculation.

    • status
      Type: stringenum
      required

      Processing state. complete and failed are final.

      values
      queuedrunningcompletefailed
    • statusUrl
      Type: stringFormat: uri
      required

      URL to retrieve this Calculation until it reaches a final state.

    • approvalRequest
      Type: object

      Exact request body to send unchanged to Approve a Pay Run. Present only when the Calculation is complete and ready for approval.

      Properties: 1
    • completedAt
      Type: stringFormat: date-time

      When the Calculation completed or failed. Present only in a final state.

    • employmentResultsUrl
      Type: stringFormat: uri

      URL of the paginated Employment results. Present only when the Calculation is complete.

    • issues
      Type: array of object 1…

      Problems that caused the Calculation to fail. Present when status is failed.

      Properties: 9
    • totals
      Type: object

      Reconciled employer totals. Present only when the Calculation is complete.

      Properties: 5