Payroll API Endpoint error

Hi everyone,

I’m trying to access the payroll api endpoint:

https://api.freeagent.com/v2/payroll\:year

which I get an empty JSON response.

If I try: https://api.freeagent.com/v2/payroll/:year/:period, I get a “Resource not found” error message.

My user access is Level 8 and when I download the backup from within FreeAgent, the large spreadsheet has the “Payslips” sheet with all the data.

Please can you help.

Thanks!

Hi xhan,

Thank you for your post! Hopefully I can help you out here.

For this URL, you need to replace :year with the year you would like to query, e.g. https://api.freeagent.com/v2/payroll/2022, and for the second query, you need to replace both :year and :period, for example if you want details of the first payroll period in the year 2022, you would use the URL https://api.freeagent.com/v2/payroll/2022/0

I hope this helps!

Kind regards,
Katie