Changelog

We have just released a new API Version: 2022-03-02! Version 2021-07-28 is now deprecated and its usage is discouraged in new implementations.

A new field sync_status was added to the paystubs.added and shifts.added webhook payloads. This field indicates the progress of the sync between your user's payroll platform's data and Pinwheel's data. For more information, see the Income and Employment Guide

As a convenience we are now exposing the platform_name in the account.added webhook event.

Added the ability to disconnect a payroll account using POST /v1/accounts/{id}/disconnect. Disconnected payroll accounts have no Recurring Access, e.g., On Demand Updates will no longer work and Monitoring will no longer be performed. All existing data for the account will be retained so it can still be accessed.

Deprecated the account.disconnected and account.reconnected webhook events. Use account.monitoring_status.updated instead. We are coordinating with customers currently using these webhook events to sunset usage and transition to the new event.

• Modified REST API endpoints:
  • Changed GET /accounts/{account_id} and GET /accounts
    • New monitoring_status in the data field, indicating the ability of Pinwheel to automatically monitor for data changes in the payroll account.
• New REST API endpoints:
  • Added POST /accounts/{account_id}/disable_monitoring
    • This is a renaming of the POST /accounts/{account_id}/disconnect REST API endpoint. We are coordinating with customers currently using this endpoint to sunset usage and transition to the new endpoint.

Added account.monitoring_status.updated webhook event. It is triggered whenever a payroll account's monitoring status is updated.

React (2.3.4) and React Native (2.3.4) packages updated to:

I&E Monitoring released in beta. To support this new feature we've made the following modifications to REST API endpoints:

Added a new enum value unpaid to earnings category for paystubs and shifts.