Learn about and configure recurring payroll
WEEKLY
- once a week on Monday 12AM UTCMONTHLY
- once a month on the first day of the month 12AM UTCpay_date
of the account,
retrieving the new data that falls after this. Recurring checks can be enabled for all users or for individual users. This also applies to the recurring check configuration where the frequency and end date of the recurring
check can be applied on the user level or to the client level. If a user has a configuration for a given field, it will always take precedence over the client level configuration. If the user has a partial configuration,
then the fields that are not configured will be taken from the client configuration if present.
Authorised
statusGET /users/recurring
endpoint. For a user to be eligible for the recurring check they need to have at least one account that matches
the above criteria. An account is considered active if the payroll provider has not marked it as inactive and the latest pay_date
for the account is not older than 40 days.
A duplicate account is defined as multiple accounts with the same username and payroll provider combination for a given user. If there are duplicate accounts then Teal will take the one with the most recent activity (time of last fetch of payroll), or the
by the creation time (most recently created). A user can have multiple active accounts with different providers and all of these accounts will be part of the recurring update.
To see which accounts would be part of the recurring schedule for a given user you can call the GET /accounts/recurring
endpoint.
HOURLY
in this environment if you choose.