GuidesAPI ReferenceChangelog
Log In

Sandbox for On Demand Updates

Sandbox re-authentication testing scenarios are now available for On Demand Updates. To learn more check out the On Demand Updates Sandbox guide

Added and Deleted Shifts and Paystubs in Webhook Payloads

We updated the paystubs.added and shifts.added webhook event payloads with two new fields:

added

Platform Types

We now designate platforms with a type, which can be one of two values: payroll and time_and_attendance. Almost all platforms are payroll. The platforms that are designated time_and_attendance are those that return shifts data but do not support payroll jobs such as direct_deposit_switch and paystubs. Platforms that support both shifts and payroll jobs are considered payroll platforms.

added

Add connected to List Accounts endpoint

We added an optional connected query parameter to the List Accounts endpoint.

added

New API Version: 2022-03-02

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.

added

Add sync_status to paystubs and shifts added webhook payloads

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

added

Webhook update: account.added

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

added

Disconnect a payroll account

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

Deprecate obsolete disconnected and reconnected webhook events

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.

added

Monitoring Status in API Endpoints

  • 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.