Skip to content

Payroll API

This forum is dedicated to gathering feedback and ideas for Xero's Payroll API.

Payroll API

Categories

75 results found

  1. The Employees endpoint in the NZ Payroll API returns all Employees of the Organisation. There is no way to distinguish between the "current" Employees and "old/former" Employees.

    This means any UI showing the Employees includes everybody rather than just the current Employees. Where the user should only be selecting "current" Employees we should be able to provide them a drop down that is limited to the valid choices!

    This is not currently possible because the API does not expose the status of the Employee.

    4 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  Employees  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  2. 1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  Employees  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  3. Xero lets you define public holidays, assign them to holiday groups, and assign a holiday group to an employee. I'd really like to be able to:

    • Retrieve the list of holiday groups and holidays defined for each.
    • Include the name of the assigned holiday group for each employee when retrieving the list of employees.
    8 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  Employees  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  4. In Payroll NZ it is not possible to filter payruns by payroll calendar id or period start or end date whereas it is in payroll AU
    GET https://api.xero.com/payroll.xro/2.0/payRuns
    would be a big help to have this!

    3 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  5. Provide validation errors with a code attribute on the returned object or prefix the error code to the returned message.

    2 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  6. I want to retrieve a list of unprocessed timesheets.

    In the Australian Payroll API you can filter the list of timesheets you retrieve by modification date, so you don't get 1000s of historical timesheets.

    However, in the New Zealand Payroll API this is not possible.
    Please add the ability to filter the list of timesheets by either status or modification date.

    5 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    2 comments  ·  Timesheets  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  7. Please allow for the net pay attribute to be nullable, as Xero calculates net pay within the payslip. If net pay is null, don't generate a validation warning that the calculated net pay is different from the provided net pay.

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  Payslips  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  8. Can anyone give me a c# Xero Payroll API sample code for leave applications

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  Leave  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  9. For PayrollNZ Employee currently it is not possible to add or update the payrollCalendarID, whereas it is possible in PayrollAU

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  Employees  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  10. There is no way to distinguish between archived and active Pay Calendars via the API.

    An argument could be made for excluding them from this API call all together. At the very least there should be a way to tell if a Calendar is archived or not.

    3 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  11. 1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  12. There is no way of telling is a pay item is inactive in the current API, meaning when you retrieve one and try and use it with the API somewhere later it fails. If you can make something inactive in Xero, the API should really provide this info.

    Adding the status field (or returning only active ones) would make this better.

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  General  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  13. It would be nice to be able to hook into the leave events, requested, accepted, rejected etc.

    My use case for this is automatically adding leave requests to a calendar, and updating existing ones when their status changes.

    8 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  Leave  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  14. One of my clients moved to KeyPay integrated with Xero in February, as we have to pay over 200 employees per month.

    I've just found out, because I ran an activity statement for March and it didn't show any W1 or W2, that the Xero API prevents KeyPay from posting wages and PAYG accordingly! Pretty useless, that! And I can't even run a report in Xero as it doesn't show in there either.

    As I've just discovered this, it means I've also under-reported the February W1 and W2 to the ATO so I'll have to amend it. And run reports…

    3 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  15. Currently there is no way to determine the end date for a twice monthly calendar.

    I can think of two solutions:
    1. Expose the "calculatePeriods" function as an end point
    2. Add EndDate to the result of the PayCalendars end point

    4 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  General  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  16. I would like to add Employee photo and emergency contact information using API , in API documentation, there is no field/tag to upload employee photo and emergency contact . Please add this feature as well.

    Thanks!

    18 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    15 comments  ·  Employees  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  17. Also known as a group certificate, in Australia at the end of financial year employees need to be given a payment summary.

    To my knowledge this is not yet possible in Xero API. It would be great if this was added.

    8 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  18. It indicates you can do this for Invoices by setting the “Accept” value in the http header to “application/pdf”. I want the same functionality for the Paystubs/Payslips

    34 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    6 comments  ·  Payslips  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  19. The basic method to terminate an employee is to set their termination date. However to re-instate an employee requires accessing the web-interface and choosing the re-instate button.
    As far as I can tell, this only removes the termination date from the employee record. It should be possible to remove that value in the API to allow re-instatement easily.

    5 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  Employees  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  20. In terms of what you have done around the Invoices paging, but now including all the line items, Do you have any plans to do something similar with the Payroll/payrun endpoint? Eg at the moment, I can get a payrun with a list of payslips on them, but I then have to make a call for each payslip to get the details of the payslip.

    If I have a PayRun with 100 Payslips, using the C# Wrapper, certainly, I have to make 100 calls to get all the details from the API, so that I can get the EarningsLines and…

    11 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    2 comments  ·  Payslips  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  • Don't see your idea?