Settings


Overview

URL https://api.xero.com/payroll.xro/1.0/Settings
Methods Supported GET
Description Allows you to retrieve the Payroll settings of a Xero organisation

Elements for Settings

The following elements are returned
Accounts Payroll Account details for SuperExpense, SuperLiabilty, WagesExpense, PAYGLiability & WagesPayable. See Accounts
Tracking Categories Tracking categories for Employee’s and Timesheet’s. See Tracking Categories
DaysInPayrollYear Number of days in the Payroll year

Elements for Accounts

AccountID Xero account identifier. e.g c56b19ef-75bf-45e8-98a4-e699a96609f7
Type See Account Types
Code Customer defined account code eg. 200
Name Name of account

Elements for Tracking Categories

TrackingCategoryID Xero tracking category identifier. e.g c56b19ef-75bf-45e8-98a4-e699a96609f7
TrackingCategoryName Name of tracking category

GET Settings

By default using GET Settings will return the Payroll settings of a Xero organisation.

Example response for GET Settings

<Settings>
    <Accounts>
      <Account>
        <AccountID>13918178-849a-4823-9a31-57b7eac713d7</AccountID>
        <Type>BANK</Type>
        <Code>090</Code>
        <Name>Business Bank Account</Name>
      </Account>
      <Account>
        <AccountID>ba416522-8509-46e8-b54a-c2fe9ede6cd4</AccountID>
        <Type>WAGESPAYABLELIABILITY</Type>
        <Code>804</Code>
        <Name>Wages Payable - Payroll</Name>
      </Account>
      <Account>
        <AccountID>4d111d55-1c71-46b4-8cbc-d8b54d8d54c5</AccountID>
        <Type>PAYGLIABILITY</Type>
        <Code>825</Code>
        <Name>PAYG Withholdings Payable</Name>
      </Account>
      <Account>
        <AccountID>479252dc-1e01-4a86-a452-9552a191453f</AccountID>
        <Type>SUPERANNUATIONEXPENSE</Type>
        <Code>478</Code>
        <Name>Superannuation</Name>
      </Account>
      <Account>
        <AccountID>a47d1f5b-5297-484a-8a8a-64a75053e4f4</AccountID>
        <Type>SUPERANNUATIONLIABILITY</Type>
        <Code>826</Code>
        <Name>Superannuation Payable</Name>
      </Account>
      <Account>
        <AccountID>c4f12f09-846e-4f6f-b39c-dff3be3e49a7</AccountID>
        <Type>WAGESEXPENSE</Type>
        <Code>477</Code>
        <Name>Wages and Salaries</Name>
      </Account>
    </Accounts>
    <TrackingCategories>
      <EmployeeGroups>
        <TrackingCategoryID>093af706-c2aa-4d97-a4ce-2d205a017eac</TrackingCategoryID>
        <TrackingCategoryName>Region</TrackingCategoryName>
      </EmployeeGroups>
      <TimesheetCategories>
        <TrackingCategoryID>e82f62ea-a798-4231-aaf0-c87f7e2798da</TrackingCategoryID>
        <TrackingCategoryName>Department</TrackingCategoryName>
      </TimesheetCategories>
    </TrackingCategories>
    <DaysInPayrollYear>365</DaysInPayrollYear>
  </Settings>