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 Bank, WagesPayable and WagesExpense. See Accounts
Tracking Categories Tracking categories for Employees and Timesheets. See Tracking Categories

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>ceef66a5-a545-413b-9312-78a53caadbc4</AccountID>
        <Type>BANK</Type>
        <Code>090</Code>
        <Name>Checking Account</Name>
      </Account>
      <Account>
        <AccountID>f1f489fb-9267-429e-a1dc-bc63a7c3f71e</AccountID>
        <Type>WAGESPAYABLE</Type>
        <Code>216</Code>
        <Name>Wages Payable – Payroll</Name>
      </Account>
      <Account>
        <AccountID>ff2ae00d-8193-496f-8ea6-318be3bec247</AccountID>
        <Type>WAGESEXPENSE</Type>
        <Code>669</Code>
        <Name>Wages &amp; Salaries - California</Name>
      </Account>
    </Accounts>
    <TrackingCategories>
      <EmployeeGroups>
        <TrackingCategoryID>43bb5948-a4dd-4029-93be-f9274e15f5e6</TrackingCategoryID>
        <TrackingCategoryName>Region</TrackingCategoryName>
      </EmployeeGroups>
      <TimesheetCategories>
        <TrackingCategoryID>b349f7bf-77ab-4448-9278-6bf3c4694d7c</TrackingCategoryID>
        <TrackingCategoryName>Colour</TrackingCategoryName>
      </TimesheetCategories>
    </TrackingCategories>
    <OpeningBalanceDate>2013-10-01T00:00:00Z</OpeningBalanceDate>
  </Settings>