Skip to content

Payroll API

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

Payroll API

Categories

JUMP TO ANOTHER FORUM

69 results found

  1. If you use the API to modify a leave application (e.g. approve it), the history of the leave application shows that the modification was made by the user that authorised Xero into our App. Everywhere else in Xero the history shows the name of the App as the modifier (this is better as it may not have been that person that authorised).

    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)
  2. To add/update Employee, Leave, Timesheet data, we are supporting multiple records sync through a single API request in AU version.
    But, in UK version, need to trigger separate APIs for every data sync. Can we support the same (bulk data sync) as in AU version?

    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)
  3. Unable to sync leave records via API. Because, we must be update holiday group & work pattern in Xero manually, before syncing leave records. Is it possible to update those data via any APIs?

    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)
    1. Employees are typically assigned an employee number, but the system currently generates a GUID instead.

    2. Since employees are unaware of their GUID, the only way to retrieve a specific record is by fetching all employees and filtering manually, which significantly impacts performance—especially for companies with a large workforce.

    3. Our goal is to allow employees to enter their employee number via our mobile app to verify their employment. This number is familiar to them, unlike the system-generated GUID

    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)
    1. Xero already offers a manual Pay Advance process, but this functionality is not exposed via API.

    2. This feature is essential for our application, enabling employees in urgent financial situations (e.g., requiring funds for car repairs before payday) to apply for a pay advance through our app.

    3. Once an employee submits a request, we intend to create the Pay Advance entry directly in Xero Payroll. Given the potential volume of requests, a manual approach is not viable.

    4. Since this functionality already exists in Xero Payroll, exposing it via API should be straightforward and would significantly improve efficiency.

    https://central.xero.com/s/article/Pay-an-advance-to-an-employee

    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)
  4. When we use the API to post Leave entries from our application, other earnings line items in the payslip are being removed.

    This issue occurs specifically when the Leave falls within the same fortnightly pay period after the payslip has been created for the employee.

    Example:
    An employee has the following earnings on their payslip:
    - Ordinary Hours
    - Overtime Hours
    - Bonus

    After we send the Leave entry via the API, the Overtime Hours and/or Bonus earnings line items are removed from the payslip, leaving only the Ordinary Hours.

    This behavior seems unintended, as adding a Leave entry should…

    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)
  5. Currently within the API a leave application's LeaveApplicationID changes when the leave request transitions to the scheduled state. There should be the ability within the API to reference the original LeaveApplicationID for traceability.

    Use Case: enable external systems attempting to track information relating to leave requests to be able to identify the lifecycle of a leave request without having to match start / end dates and employee separately

    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)
  6. If a user has more than 200 pay runs, I need to retrieve the first page initially of https://developer.xero.com/documentation/api/payrolluk/payruns#get-payruns endpoint, then it will provide the number of items in response and then I need to retrieve the following pages with pay runs that I need to process.
    More paid pay runs means more call to Xero, so it can be a problem on production env in a few weeks/years.

    It makes sense to add additional request parameters to filter not needed pay runs. For instance, posted date, then I can retrieve items only for the last week.

    Best practices of…

    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)
  7. The note tab on each employee file can be enhanced with the ability to add files such as their work contract/s or ID, perhaps even workings related to holidays or payment plans agreed upon, etc. Having the ability to upload can provide the opportunity to load signed agreements which is more important than a "note". The option to make a note visable or not could be useful to employee/employer too.

    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)
  8. For Xero NZ Leave Type APIs, can you guy add the unit type, we need to filter out leave types of a specific type like "Dollars", but currently the data only available when pulling leave balances of employee (by each leave types).

    Thank you!

    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. I am trying to link employees to their tracking category however the New Zealand Payroll Api doesn’t appear to expose any way to do this.

    Currently the Australian payroll Api supports this functionality exposing the ‘EmployeeGroupName’ on each employee

    Endpoint - https://api.xero.com/payroll.xro/1.0/employees

    Field - EmployeeGroupName": {

      "description": "The Employee Group allows you to report on payroll expenses and liabilities for each group of employees",
    
      "type": "string",
    
      "example": "marketing"
    

    }

    Is there a way to make this type of connection with the NZ Payroll API?

    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

    1 comment  ·  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)
  10. There is no way to determine which employee group an Employee is a member of, or what their default pay is (NZ/UK)

    Could it please be added to the Employee or Employment endpoints along with the Hours/Rate/Salary info for NZ/UK Employment? Add/update would be great too.

    Thanks

    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)
  11. At the moment it's possible to create Statutory Sick records via the API, but not possible to delete them. We're trying to integrate our product with Xero, but we need to be able to delete sick entries if they've been added mistakenly.

    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)
  12. Unfortunately, UK timesheets API doesn't support filtering by date. That means in order to update a timesheet the client needs to page through every single timesheet in history! It's completely unworkable.

    Please add timesheet filter by date!

    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  ·  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)
  13. 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)
  14. 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)
  15. 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)
  16. 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)
  17. 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)
  18. 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)
  • Don't see your idea?