Xero Payroll API

Ideas for improving the Xero Payroll APIs

You've used all your votes and won't be able to post a new idea, but you can still search and comment on existing ideas.

There are two ways to get more votes:

  • When an admin closes an idea you've voted on, you'll get your votes back from that idea.
  • You can remove your votes from an open idea you support.
  • To see ideas you have already voted on, select the "My feedback" filter and select "My open ideas".
(thinking…)

Enter your idea and we'll search to see if someone has already suggested it.

If a similar idea already exists, you can support and comment on it.

If it doesn't exist, you can post your idea so others can support it.

Enter your idea and we'll search to see if someone has already suggested it.

  1. UK API

    UK Payroll API please

    80 votes
    Vote
    Sign in
    Check!
    (thinking…)
    Reset
    or sign in with
    • facebook
    • google
      Password icon
      I agree to the terms of service
      Signed in as (Sign out)
      You have left! (?) (thinking…)
      10 comments  ·  General  ·  Flag idea as inappropriate…  ·  Admin →

      Hi everyone,

      Great news – work on the UK payroll API has begun!

      Rather than replicating what we’ve done with AU and US APIs we’ll be rebuilding the UK API from the ground up. That means it’s going to take a little longer, but should provide a much better developer and integration experience (json etc).

      We’ve not got any release dates in mind yet, but lets just say there’s an event in London in October we’d love to be ready for. If you’re already a partner, get in touch with your local developer evangelist about being part of the beta.

      Finally, we’d love some help prioritising the endpoints and functionality we work on first. Please let us know in the comments what’s most critical to your app.

      Cheers,
      Adam

    • Payroll API for New Zealand

      It would be great to have a payroll API for New Zealand so that we could develop the same features for Australian and New Zealand clients.

      For example, as part of integrating our travel online booking tool being able to export employee data like first name, last name and email will enable the creation of traveller profiles to be streamlined for Xero NZ cilents.

      68 votes
      Vote
      Sign in
      Check!
      (thinking…)
      Reset
      or sign in with
      • facebook
      • google
        Password icon
        I agree to the terms of service
        Signed in as (Sign out)
        You have left! (?) (thinking…)
        4 comments  ·  Flag idea as inappropriate…  ·  Admin →
      • Allow the viewing of all leave applications

        Currently the LeaveApplications endpoint in the Payroll API only lets you see approved leave applications. I believe it should show all leave applications (awaiting approval, approved, rejected) with an appropriate status for each.

        A use case for this is to develop an automated shared calendar that lists all leave for an organisation, with leave awaiting approval in as "tentative" and approved leave in as "confirmed", allowing all employees to see at a glance if someone else is taking leave at the time they're going to request.

        57 votes
        Vote
        Sign in
        Check!
        (thinking…)
        Reset
        or sign in with
        • facebook
        • google
          Password icon
          I agree to the terms of service
          Signed in as (Sign out)
          You have left! (?) (thinking…)
          6 comments  ·  Leave  ·  Flag idea as inappropriate…  ·  Admin →
        • delete leave application via API

          delete leave application via API

          53 votes
          Vote
          Sign in
          Check!
          (thinking…)
          Reset
          or sign in with
          • facebook
          • google
            Password icon
            I agree to the terms of service
            Signed in as (Sign out)
            You have left! (?) (thinking…)
            6 comments  ·  Leave  ·  Flag idea as inappropriate…  ·  Admin →
          • be able to overwrite timesheets via the API

            There is no way to delete Approved timesheets or revert them to Draft through the API. Sending a timesheet that already exists returns a message from Xero saying that the TimesheetID needs to be supplied as the timesheet already exists. Supplying the TimesheetID then returns a message saying that the timesheet is not in Draft. Another option would be to let the user revert multiple timesheets to Draft (in a similar way to how they can approve multiple timesheets at once).

            34 votes
            Vote
            Sign in
            Check!
            (thinking…)
            Reset
            or sign in with
            • facebook
            • google
              Password icon
              I agree to the terms of service
              Signed in as (Sign out)
              You have left! (?) (thinking…)
              1 comment  ·  Timesheets  ·  Flag idea as inappropriate…  ·  Admin →
            • Payslip endpoint is missing fields

              Payslip endpoint seems to be incomplete e.g. YTD data?

              26 votes
              Vote
              Sign in
              Check!
              (thinking…)
              Reset
              or sign in with
              • facebook
              • google
                Password icon
                I agree to the terms of service
                Signed in as (Sign out)
                You have left! (?) (thinking…)
                1 comment  ·  Payslip  ·  Flag idea as inappropriate…  ·  Admin →
              • Reject Leave Application

                Need ability to change a LeaveApplication status to REJECTED

                20 votes
                Vote
                Sign in
                Check!
                (thinking…)
                Reset
                or sign in with
                • facebook
                • google
                  Password icon
                  I agree to the terms of service
                  Signed in as (Sign out)
                  You have left! (?) (thinking…)
                  1 comment  ·  Leave  ·  Flag idea as inappropriate…  ·  Admin →
                • Allow return of Paystubs/Payslips in pdf format

                  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

                  16 votes
                  Vote
                  Sign in
                  Check!
                  (thinking…)
                  Reset
                  or sign in with
                  • facebook
                  • google
                    Password icon
                    I agree to the terms of service
                    Signed in as (Sign out)
                    You have left! (?) (thinking…)
                    1 comment  ·  Payslip  ·  Flag idea as inappropriate…  ·  Admin →
                  • Allow querying payslips of an employee

                    Please provide a way to fetch payslips by employee id.

                    Either adding a payslips element to Employees or providing a Payrolls API will do.

                    13 votes
                    Vote
                    Sign in
                    Check!
                    (thinking…)
                    Reset
                    or sign in with
                    • facebook
                    • google
                      Password icon
                      I agree to the terms of service
                      Signed in as (Sign out)
                      You have left! (?) (thinking…)
                      1 comment  ·  Payslip  ·  Flag idea as inappropriate…  ·  Admin →
                    • Allow retrieval of a payment summary

                      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.

                      13 votes
                      Vote
                      Sign in
                      Check!
                      (thinking…)
                      Reset
                      or sign in with
                      • facebook
                      • google
                        Password icon
                        I agree to the terms of service
                        Signed in as (Sign out)
                        You have left! (?) (thinking…)
                        0 comments  ·  Payruns & payitems  ·  Flag idea as inappropriate…  ·  Admin →
                      • Allow the employee endpoint to re-instate an employee.

                        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.

                        12 votes
                        Vote
                        Sign in
                        Check!
                        (thinking…)
                        Reset
                        or sign in with
                        • facebook
                        • google
                          Password icon
                          I agree to the terms of service
                          Signed in as (Sign out)
                          You have left! (?) (thinking…)
                          0 comments  ·  Employees  ·  Flag idea as inappropriate…  ·  Admin →
                        • Employees endpoint: expose more data

                          Expose other information on Employees endpoint, such as their bank, rate and tax details

                          10 votes
                          Vote
                          Sign in
                          Check!
                          (thinking…)
                          Reset
                          or sign in with
                          • facebook
                          • google
                            Password icon
                            I agree to the terms of service
                            Signed in as (Sign out)
                            You have left! (?) (thinking…)
                            1 comment  ·  Employees  ·  Flag idea as inappropriate…  ·  Admin →
                          • Expose detailed Employee taxes

                            The Xero Payroll UI shows detailed the Employee Taxes in Paystub/payslip such as Federal Income, SSN, Medicare, State Withholding etc.

                            However the Paystubs API only returns the total of that taxes

                            7 votes
                            Vote
                            Sign in
                            Check!
                            (thinking…)
                            Reset
                            or sign in with
                            • facebook
                            • google
                              Password icon
                              I agree to the terms of service
                              Signed in as (Sign out)
                              You have left! (?) (thinking…)
                              2 comments  ·  Employees  ·  Flag idea as inappropriate…  ·  Admin →
                            • Allow entry of a default or base hourly rate per employee

                              When feeding timesheets into Payroll, there is nowhere to specify an hourly rate for Ordinary Hours. The only way to get around this is to set up a default pay per employee that pays 0 hours at the required rate. It works, but is not very intuitive.

                              6 votes
                              Vote
                              Sign in
                              Check!
                              (thinking…)
                              Reset
                              or sign in with
                              • facebook
                              • google
                                Password icon
                                I agree to the terms of service
                                Signed in as (Sign out)
                                You have left! (?) (thinking…)
                                0 comments  ·  Payruns & payitems  ·  Flag idea as inappropriate…  ·  Admin →
                              • Payrun Payslip Results Paging

                                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…

                                4 votes
                                Vote
                                Sign in
                                Check!
                                (thinking…)
                                Reset
                                or sign in with
                                • facebook
                                • google
                                  Password icon
                                  I agree to the terms of service
                                  Signed in as (Sign out)
                                  You have left! (?) (thinking…)
                                  1 comment  ·  Payslip  ·  Flag idea as inappropriate…  ·  Admin →
                                • Employee photo and emergency contact information using API

                                  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!

                                  4 votes
                                  Vote
                                  Sign in
                                  Check!
                                  (thinking…)
                                  Reset
                                  or sign in with
                                  • facebook
                                  • google
                                    Password icon
                                    I agree to the terms of service
                                    Signed in as (Sign out)
                                    You have left! (?) (thinking…)
                                    0 comments  ·  Employees  ·  Flag idea as inappropriate…  ·  Admin →
                                  • Terminating an Employee should be incorporated into a Wizard Function.

                                    From review of the Xero's instructions there are several steps and places that you need to go just to terminate an employee. Surely this can be incorporated into a Wizard feature whereby you choose to terminate one or more selected employees and Xero takes you through the necessary steps to effectively and correctly terminate an employee/s.

                                    4 votes
                                    Vote
                                    Sign in
                                    Check!
                                    (thinking…)
                                    Reset
                                    or sign in with
                                    • facebook
                                    • google
                                      Password icon
                                      I agree to the terms of service
                                      Signed in as (Sign out)
                                      You have left! (?) (thinking…)
                                      0 comments  ·  Employees  ·  Flag idea as inappropriate…  ·  Admin →
                                    • Include tax and filing information in US Payroll API

                                      We are building some automated processes that help us process payroll approvals and provide tax information to a growing number of clients and it would be very useful to have access to the payroll taxes and filings information in Xero. In particular I would like to see the following information exposed in the US Payroll API:

                                      1.) ALL pay run data that is included on the Xero web UI. Currently, benefits and employer taxes are not included in the API data, making it impossible for us to communicate the total cost of a payroll to an approving party.

                                      2.) Taxes…

                                      3 votes
                                      Vote
                                      Sign in
                                      Check!
                                      (thinking…)
                                      Reset
                                      or sign in with
                                      • facebook
                                      • google
                                        Password icon
                                        I agree to the terms of service
                                        Signed in as (Sign out)
                                        You have left! (?) (thinking…)
                                        0 comments  ·  Flag idea as inappropriate…  ·  Admin →
                                      • API endpoint for US supported states

                                        Have an endpoint where it is possible to get an updated list of all the US supported states in the api us payroll

                                        2 votes
                                        Vote
                                        Sign in
                                        Check!
                                        (thinking…)
                                        Reset
                                        or sign in with
                                        • facebook
                                        • google
                                          Password icon
                                          I agree to the terms of service
                                          Signed in as (Sign out)
                                          You have left! (?) (thinking…)
                                          0 comments  ·  Flag idea as inappropriate…  ·  Admin →
                                        • EarningTypeId

                                          There is a confusing discrepancy in fields naming. If I want to post a new employee, then I should set SalaryAndWage which requires EarningsTypeID field. It can be retrieved from PayItems resource by the name of EarningsRateID, RATE id - not TYPE id.

                                          1 vote
                                          Vote
                                          Sign in
                                          Check!
                                          (thinking…)
                                          Reset
                                          or sign in with
                                          • facebook
                                          • google
                                            Password icon
                                            I agree to the terms of service
                                            Signed in as (Sign out)
                                            You have left! (?) (thinking…)
                                            0 comments  ·  Employees  ·  Flag idea as inappropriate…  ·  Admin →
                                          ← Previous 1
                                          • Don't see your idea?

                                          Xero Payroll API

                                          Feedback and Knowledge Base