Skip to main content
POST
Connects a user account to a payroll provider
Retrieves the most recent payroll data for the account’s authorisation. May return an empty result if no new payroll is found.
This endpoint requires a valid authorisation for the user. If no active authorisation exists, the request will be rejected. You can optionally pass the x-teal-authorisation-id header to specify which authorisation to use; otherwise the system will resolve a valid authorisation automatically. See Authorisations for more details.

Authorizations

Authorization
string
header
required

Bearer token for authentication. The token should be the one returned by the /user-tokens endpoint.

Headers

x-teal-authorisation-id
string<uuid>

Optional authorisation ID to associate with this request. If not provided, the system will attempt to resolve a valid authorisation for the user automatically.

Example:

"7f3b8c2a-1d4e-4f6a-8b8c-9a0b1c2d3e4f"

Body

application/json
account_id
string<uuid>
required

The account id to use to connect to the payroll provider

Example:

"95a0e70b-fe02-4f47-aef9-2efff279df71"

Response

Created

account_id
string<uuid>
required

The id of the account

Example:

"95a0e70b-fe02-4f47-aef9-2efff279df71"

entry_id
string<uuid>
required

The id of the entry

payroll_submissions
object[]
required
authorisation_id
string<uuid> | null

The id of the authorisation that authorized this data retrieval

Example:

"7f3b8c2a-1d4e-4f6a-8b8c-9a0b1c2d3e4f"