Payroll Profiles
Minimum access level: Tax and Limited Accounting. Only available for UK companies (i.e. those which support payroll in FreeAgent).
Provides read-only access to payroll profiles set up in FreeAgent.
Attributes
| Attribute | Description | Kind |
|---|---|---|
| user | The unique identifier for the user being paid | URL |
| total_pay_in_previous_employment | The total amount the user was paid in previous employment during the tax year | Decimal |
| total_tax_in_previous_employment | The total amount the user was taxed in previous employment during the tax year | Decimal |
| employment_starts_on | Date the employee started. Only present if the employee started during the tax year. | Date |
| created_at | Date and time at which the payroll profile was created | Datetime |
| updated_at | Date and time at which the payroll profile was last edited | Datetime |
List all profiles for a given tax year
Returns the list of all payroll profiles for the given year end. For example, for the payroll year April 2020 - March 2021, the :year parameter should be 2021.
GET https://api.freeagent.com/v2/payroll_profiles/:year
Response
Status: 200 OK
{
"profiles": [
{
"user": "https://api.freeagent.com/v2/users/107",
"total_pay_in_previous_employment": "1000.0",
"total_tax_in_previous_employment": "200.0",
"created_at": "2024-08-07T14:27:32.000Z",
"updated_at": "2024-08-07T14:27:32.000Z"
},
{
"user": "https://api.freeagent.com/v2/users/96",
"total_pay_in_previous_employment": "0.0",
"total_tax_in_previous_employment": "0.0",
"employment_starts_on": "2024-06-29",
"created_at": "2024-06-07T15:13:24.000Z",
"updated_at": "2024-07-11T17:31:04.000Z"
}
]
}
Payroll profile for a particular user
Returns the payroll profile in the given tax year for a particular user.
GET https://api.freeagent.com/v2/payroll_profiles/:year?user=https://api.freeagent.com/v2/users/107
Response
Status: 200 OK
{
"profiles": [
{
"user": "https://api.freeagent.com/v2/users/107",
"total_pay_in_previous_employment": "1000.0",
"total_tax_in_previous_employment": "200.0"
}
]
}