Skip to content

Payroll API

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

Payroll API

Categories

81 results found

  1. Would like the ability to put variable/custom deductions against each employee without first initiating a payrun. Each deduction added will be included in the next payrun. This is different to a fixed deduction amount that can be created within the pay template. This new feature will also enable payroll to place deductions against employees without waiting for a payrun to start.

    Presently we'd need to PUT a deduction to pay template > post payrun > delete payitem in template > PUT new deduction amount (repeat this process every pay cycle).

    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)
  2. For the PayRunStatus in GET PayRuns you show DRAFT and POSTED, it should also be possible to get FILED status so we can see if it's been filed for STP.

    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

    1 comment  ·  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. Hi,
    I am working for one of my UK based client to integrate Payroll API's where I need to fetch data with my own sorting/ordering like the data can sort by first/last name, startDate, ect. Same I need for the filter. I know you allow some filters like by first/last name but here I need a custom filter which allow me to fetch data between two startDates.
    And also I am looking for to get the payrun data with the help of "payrollCalendarID" something like
    https://api.xero.com/payroll.xro/2.0/payRuns?payrollCalendarID={payrollCalendarID}

    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  ·  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. The addition of NI Number is missing. Also Paid intermittently field is missing on the Employment POST API Endpoint

    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)
  5. 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

    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)
  6. Like AU payroll api, UK payroll api should also have POST end-point so that applications can automatically post payroll information rather than entering them manually.

    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  ·  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)
  7. Hello,
    We are working on a UK integration to your endpoint (version 2.0), and we noticed that you only allow a POST-method for your Employment-endpoint.

    We would need you to introduce a GET-method as we need to access the NationalInsuranceCategory-property.
    I imagine you just forgot to implement a get-method for it?
    Thanks
    Thank you!

    Kind regards Anders

    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)
  8. 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)
  9. 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. 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)
  11. 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)
  12. 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)
  13. 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)
  14. 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)
  15. 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)
  16. 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)
  17. 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)
  18. 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)
  19. 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)
  20. 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.

    9 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)
  • Don't see your idea?