Xero Connector > Xero operations > Xero objects and operations
  

Xero objects and operations

Xero objects are grouped by API. Each table lists the supported GET operations for objects in that API.
Objects like Payroll, Projects, Assets, and Files require the matching Xero subscription and OAuth scopes.
For Payroll objects, Xero returns data only for a tenant in the following regions: UK, NZ, or AU.

Accounting

The following table lists the GET operations that you can use for Accounting API objects:
Xero Object
Relative Path to the Object
Accounts
/api.xro/2.0/Accounts
/api.xro/2.0/Accounts/{AccountID}
/api.xro/2.0/Accounts/{AccountID}/Attachments
/api.xro/2.0/Accounts/{AccountID}/Attachments/{AttachmentID}
/api.xro/2.0/Accounts/{AccountID}/Attachments/{FileName}
Bank Transactions
/api.xro/2.0/BankTransactions
/api.xro/2.0/BankTransactions/{BankTransactionID}
/api.xro/2.0/BankTransactions/{BankTransactionID}/Attachments
/api.xro/2.0/BankTransactions/{BankTransactionID}/History
/api.xro/2.0/BankTransactions/{BankTransactionID}/Attachments/{AttachmentID}
/api.xro/2.0/BankTransactions/{BankTransactionID}/Attachments/{FileName}
Bank Transfers
/api.xro/2.0/BankTransfers
/api.xro/2.0/BankTransfers/{BankTransferID}
/api.xro/2.0/BankTransfers/{BankTransferID}/Attachments
/api.xro/2.0/BankTransfers/{BankTransferID}/History
/api.xro/2.0/BankTransfers/{BankTransferID}/Attachments/{AttachmentID}
/api.xro/2.0/BankTransfers/{BankTransferID}/Attachments/{FileName}
Batch Payments
/api.xro/2.0/BatchPayments
/api.xro/2.0/BatchPayments/{BatchPaymentID}
/api.xro/2.0/BatchPayments/{BatchPaymentID}/History
Branding Themes
/api.xro/2.0/BrandingThemes
/api.xro/2.0/BrandingThemes/{BrandingThemeID}
Budgets
/api.xro/2.0/Budgets
/api.xro/2.0/Budgets/{BudgetID}
Contact Groups
/api.xro/2.0/ContactGroups
/api.xro/2.0/ContactGroups/{ContactGroupID}
Contacts
/api.xro/2.0/Contacts
/api.xro/2.0/Contacts/{ContactID}
/api.xro/2.0/Contacts/{ContactNumber}
/api.xro/2.0/Contacts/{ContactID}/Attachments
/api.xro/2.0/Contacts/{ContactID}/CISSettings
/api.xro/2.0/Contacts/{ContactID}/History
/api.xro/2.0/Contacts/{ContactID}/Attachments/{AttachmentID}
/api.xro/2.0/Contacts/{ContactID}/Attachments/{FileName}
Credit Notes
/api.xro/2.0/CreditNotes
/api.xro/2.0/CreditNotes/{CreditNoteID}
/api.xro/2.0/CreditNotes/{CreditNoteID}/Attachments
/api.xro/2.0/CreditNotes/{CreditNoteID}/History
/api.xro/2.0/CreditNotes/{CreditNoteID}/pdf
/api.xro/2.0/CreditNotes/{CreditNoteID}/Attachments/{AttachmentID}
/api.xro/2.0/CreditNotes/{CreditNoteID}/Attachments/{FileName}
Currencies
/api.xro/2.0/Currencies
Invoice Reminders
/api.xro/2.0/InvoiceReminders/Settings
Invoices
/api.xro/2.0/Invoices
/api.xro/2.0/Invoices/{InvoiceID}
/api.xro/2.0/Invoices/{InvoiceID}/Attachments
/api.xro/2.0/Invoices/{InvoiceID}/History
/api.xro/2.0/Invoices/{InvoiceID}/OnlineInvoice
/api.xro/2.0/Invoices/{InvoiceID}/pdf
/api.xro/2.0/Invoices/{InvoiceID}/Attachments/{AttachmentID}
/api.xro/2.0/Invoices/{InvoiceID}/Attachments/{FileName}
Items
/api.xro/2.0/Items
/api.xro/2.0/Items/{ItemID}
/api.xro/2.0/Items/{ItemID}/History
Journals
/api.xro/2.0/Journals
/api.xro/2.0/Journals/{JournalID}
/api.xro/2.0/Journals/{JournalNumber}
Linked Transactions
/api.xro/2.0/LinkedTransactions
/api.xro/2.0/LinkedTransactions/{LinkedTransactionID}
Manual Journals
/api.xro/2.0/ManualJournals
/api.xro/2.0/ManualJournals/{ManualJournalID}
/api.xro/2.0/ManualJournals/{ManualJournalID}/Attachments
/api.xro/2.0/ManualJournals/{ManualJournalID}/History
/api.xro/2.0/ManualJournals/{ManualJournalID}/Attachments/{AttachmentID}
/api.xro/2.0/ManualJournals/{ManualJournalID}/Attachments/{FileName}
Organisation
/api.xro/2.0/Organisation
/api.xro/2.0/Organisation/Actions
/api.xro/2.0/Organisation/{OrganisationID}/CISSettings
Overpayments
/api.xro/2.0/Overpayments
/api.xro/2.0/Overpayments/{OverpaymentID}
/api.xro/2.0/Overpayments/{OverpaymentID}/History
Payments
/api.xro/2.0/Payments
/api.xro/2.0/Payments/{PaymentID}
/api.xro/2.0/Payments/{PaymentID}/History
Prepayments
/api.xro/2.0/Prepayments
/api.xro/2.0/Prepayments/{PrepaymentID}
/api.xro/2.0/Prepayments/{PrepaymentID}/History
Purchase Orders
/api.xro/2.0/PurchaseOrders
/api.xro/2.0/PurchaseOrders/{PurchaseOrderID}
/api.xro/2.0/PurchaseOrders/{PurchaseOrderNumber}
/api.xro/2.0/PurchaseOrders/{PurchaseOrderID}/Attachments
/api.xro/2.0/PurchaseOrders/{PurchaseOrderID}/History
/api.xro/2.0/PurchaseOrders/{PurchaseOrderID}/pdf
/api.xro/2.0/PurchaseOrders/{PurchaseOrderID}/Attachments/{AttachmentID}
/api.xro/2.0/PurchaseOrders/{PurchaseOrderID}/Attachments/{FileName}
Quotes
/api.xro/2.0/Quotes
/api.xro/2.0/Quotes/{QuoteID}
/api.xro/2.0/Quotes/{QuoteID}/Attachments
/api.xro/2.0/Quotes/{QuoteID}/History
/api.xro/2.0/Quotes/{QuoteID}/pdf
/api.xro/2.0/Quotes/{QuoteID}/Attachments/{AttachmentID}
/api.xro/2.0/Quotes/{QuoteID}/Attachments/{FileName}
Repeating Invoices
/api.xro/2.0/RepeatingInvoices
/api.xro/2.0/RepeatingInvoices/{RepeatingInvoiceID}
/api.xro/2.0/RepeatingInvoices/{RepeatingInvoiceID}/Attachments
/api.xro/2.0/RepeatingInvoices/{RepeatingInvoiceID}/History
/api.xro/2.0/RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{AttachmentID}
/api.xro/2.0/RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{FileName}
Reports
/api.xro/2.0/Reports
/api.xro/2.0/Reports/{ReportID}
Tax Rates
/api.xro/2.0/TaxRates
/api.xro/2.0/TaxRates/{TaxType}
Tracking Categories
/api.xro/2.0/TrackingCategories
/api.xro/2.0/TrackingCategories/{TrackingCategoryID}
Users
/api.xro/2.0/Users
/api.xro/2.0/Users/{UserID}
Report: 1099 (Ten Ninety Nine)
/api.xro/2.0/Reports/TenNinetyNine
Report: Aged Payables By Contact
/api.xro/2.0/Reports/AgedPayablesByContact
Report: Aged Receivables By Contact
/api.xro/2.0/Reports/AgedReceivablesByContact
Report: Balance Sheet
/api.xro/2.0/Reports/BalanceSheet
Report: Bank Summary
/api.xro/2.0/Reports/BankSummary
Report: Budget Summary
/api.xro/2.0/Reports/BudgetSummary
Report: Executive Summary
/api.xro/2.0/Reports/ExecutiveSummary
Report: Profit And Loss
/api.xro/2.0/Reports/ProfitAndLoss
Report: Trial Balance
/api.xro/2.0/Reports/TrialBalance

Payroll UK

The following table lists the GET operations that you can use for the Payroll API with UK-specific Xero organizations:
Xero Object
Relative Path to the Object
Benefits
/payroll.xro/2.0/uk/Benefits
/payroll.xro/2.0/uk/Benefits/{id}
Deductions
/payroll.xro/2.0/uk/Deductions
/payroll.xro/2.0/uk/Deductions/{deductionId}
Earnings Orders
/payroll.xro/2.0/uk/EarningsOrders
/payroll.xro/2.0/uk/EarningsOrders/{id}
Earnings Rates
/payroll.xro/2.0/uk/EarningsRates
/payroll.xro/2.0/uk/EarningsRates/{EarningsRateID}
Employee Leave
/payroll.xro/2.0/uk/Employees/{EmployeeID}/Leave
/payroll.xro/2.0/uk/Employees/{EmployeeID}/Leave/{LeaveID}
Employee Leave Balances
/payroll.xro/2.0/uk/Employees/{EmployeeID}/LeaveBalances
Employee Leave Periods
/payroll.xro/2.0/uk/Employees/{EmployeeID}/LeavePeriods
Employee Leave Types
/payroll.xro/2.0/uk/Employees/{EmployeeID}/LeaveTypes
Employee Pay Templates
/payroll.xro/2.0/uk/Employees/{EmployeeID}/PayTemplates
Employee Payment Methods
/payroll.xro/2.0/uk/Employees/{EmployeeID}/PaymentMethods
Employee Salary And Wages
/payroll.xro/2.0/uk/Employees/{EmployeeID}/SalaryAndWages
/payroll.xro/2.0/uk/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}
Employee Statutory Leave Balance
/payroll.xro/2.0/uk/Employees/{EmployeeID}/StatutoryLeaveBalance
Employee Tax
/payroll.xro/2.0/uk/Employees/{EmployeeID}/Tax
Employee UK Opening Balances
/payroll.xro/2.0/uk/Employees/{EmployeeID}/ukopeningbalances
Employees
/payroll.xro/2.0/uk/Employees
/payroll.xro/2.0/uk/Employees/{EmployeeID}
Leave Types
/payroll.xro/2.0/uk/LeaveTypes
/payroll.xro/2.0/uk/LeaveTypes/{LeaveTypeID}
Pay Run Calendars
/payroll.xro/2.0/uk/PayRunCalendars
/payroll.xro/2.0/uk/PayRunCalendars/{PayRunCalendarID}
Pay Runs
/payroll.xro/2.0/uk/PayRuns
/payroll.xro/2.0/uk/PayRuns/{PayRunID}
Payslips
/payroll.xro/2.0/uk/Payslips
/payroll.xro/2.0/uk/Payslips/{PayslipID}
Reimbursements
/payroll.xro/2.0/uk/Reimbursements
/payroll.xro/2.0/uk/Reimbursements/{ReimbursementID}
Settings
/payroll.xro/2.0/uk/Settings
Statutory Leave Summary
/payroll.xro/2.0/uk/StatutoryLeaves/Summary/{EmployeeID}
Statutory Sick Leave
/payroll.xro/2.0/uk/StatutoryLeaves/Sick/{StatutorySickLeaveID}
Timesheets
/payroll.xro/2.0/uk/Timesheets
/payroll.xro/2.0/uk/Timesheets/{TimesheetID}
Tracking Categories
/payroll.xro/2.0/uk/Settings/trackingCategories

Payroll NZ

The following table lists the GET operations that you can use for the Payroll API with NZ-specific Xero organizations:
Xero Object
Relative Path to the Object
Deductions
/payroll.xro/2.0/nz/Deductions
/payroll.xro/2.0/nz/Deductions/{deductionId}
Earnings Rates
/payroll.xro/2.0/nz/EarningsRates
/payroll.xro/2.0/nz/EarningsRates/{EarningsRateID}
Employee Leave
/payroll.xro/2.0/nz/Employees/{EmployeeID}/Leave
Employee Leave Balances
/payroll.xro/2.0/nz/Employees/{EmployeeID}/LeaveBalances
Employee Leave Periods
/payroll.xro/2.0/nz/Employees/{EmployeeID}/LeavePeriods
Employee Leave Types
/payroll.xro/2.0/nz/Employees/{EmployeeID}/LeaveTypes
Employee Opening Balances
/payroll.xro/2.0/nz/Employees/{EmployeeID}/OpeningBalances
Employee Pay Templates
/payroll.xro/2.0/nz/Employees/{EmployeeID}/PayTemplates
Employee Payment Methods
/payroll.xro/2.0/nz/Employees/{EmployeeID}/PaymentMethods
Employee Salary And Wages
/payroll.xro/2.0/nz/Employees/{EmployeeID}/SalaryAndWages
/payroll.xro/2.0/nz/Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID}
Employee Tax
/payroll.xro/2.0/nz/Employees/{EmployeeID}/Tax
Employee Working Patterns
/payroll.xro/2.0/nz/Employees/{EmployeeID}/Working-Patterns
/payroll.xro/2.0/nz/Employees/{EmployeeID}/Working-Patterns/{EmployeeWorkingPatternID}
Employees
/payroll.xro/2.0/nz/Employees
/payroll.xro/2.0/nz/Employees/{EmployeeID}
Leave Types
/payroll.xro/2.0/nz/LeaveTypes
/payroll.xro/2.0/nz/LeaveTypes/{LeaveTypeID}
Pay Run Calendars
/payroll.xro/2.0/nz/PayRunCalendars
/payroll.xro/2.0/nz/PayRunCalendars/{PayrollCalendarID}
Pay Runs
/payroll.xro/2.0/nz/PayRuns
/payroll.xro/2.0/nz/PayRuns/{PayRunID}
Pay Slips
/payroll.xro/2.0/nz/PaySlips
/payroll.xro/2.0/nz/PaySlips/{PaySlipID}
Reimbursements
/payroll.xro/2.0/nz/Reimbursements
/payroll.xro/2.0/nz/Reimbursements/{ReimbursementID}
Settings
/payroll.xro/2.0/nz/Settings
Statutory Deductions
/payroll.xro/2.0/nz/StatutoryDeductions
/payroll.xro/2.0/nz/StatutoryDeductions/{id}
Superannuations
/payroll.xro/2.0/nz/Superannuations
/payroll.xro/2.0/nz/Superannuations/{SuperannuationID}
Timesheets
/payroll.xro/2.0/nz/Timesheets
/payroll.xro/2.0/nz/Timesheets/{TimesheetID}
Tracking Categories
/payroll.xro/2.0/nz/Settings/TrackingCategories

Payroll AU (v1)

The following table lists the GET operations that you can use for the Payroll API with AU-specific Xero organizations:
Xero Object
Relative Path to the Object
Employees
/payroll.xro/1.0/Employees
/payroll.xro/1.0/Employees/{EmployeeID}
Leave Applications
/payroll.xro/1.0/LeaveApplications
/payroll.xro/1.0/LeaveApplications/v2
/payroll.xro/1.0/LeaveApplications/{LeaveApplicationID}
Pay Items
/payroll.xro/1.0/PayItems
Pay Runs
/payroll.xro/1.0/PayRuns
/payroll.xro/1.0/PayRuns/{PayRunID}
Payroll Calendars
/payroll.xro/1.0/PayrollCalendars
/payroll.xro/1.0/PayrollCalendars/{PayrollCalendarID}
Payslip
/payroll.xro/1.0/Payslip/{PayslipID}
Settings
/payroll.xro/1.0/Settings
Superfund Products
/payroll.xro/1.0/SuperfundProducts
Superfunds
/payroll.xro/1.0/Superfunds
/payroll.xro/1.0/Superfunds/{SuperFundID}
Timesheets
/payroll.xro/1.0/Timesheets
/payroll.xro/1.0/Timesheets/{TimesheetID}

Payroll AU (v2)

The following table lists the GET operations that you can use for the Payroll API with AU-specific Xero organizations:
Xero Object
Relative Path to the Object
Timesheets
/payroll.xro/2.0/au/Timesheets
/payroll.xro/2.0/au/Timesheets/{TimesheetID}

Files

The following table lists the GET operations that you can use for Files API objects:
Xero Object
Relative Path to the Object
Associations
/files.xro/1.0/Associations/Count
/files.xro/1.0/Associations/{ObjectId}
Files
/files.xro/1.0/Files
/files.xro/1.0/Files/{FileId}
/files.xro/1.0/Files/{FileId}/Associations
/files.xro/1.0/Files/{FileId}/Content
Folders
/files.xro/1.0/Folders
/files.xro/1.0/Folders/{FolderId}
Inbox
/files.xro/1.0/Inbox

Assets

The following table lists the GET operations that you can use for Assets API objects:
Xero Object
Relative Path to the Object
Asset Settings
/assets.xro/1.0/Settings
Asset Types
/assets.xro/1.0/AssetTypes
Assets
/assets.xro/1.0/Assets
/assets.xro/1.0/Assets/{id}

Projects

The following table lists the GET operations that you can use for Projects API objects:
Xero Object
Relative Path to the Object
Project Tasks
/projects.xro/2.0/Projects/{projectId}/Tasks
/projects.xro/2.0/Projects/{projectId}/Tasks/{taskId}
Project Time Entries
/projects.xro/2.0/Projects/{projectId}/Time
/projects.xro/2.0/Projects/{projectId}/Time/{timeEntryId}
Projects
/projects.xro/2.0/Projects
/projects.xro/2.0/Projects/{projectId}
Projects Users
/projects.xro/2.0/ProjectsUsers

Identity

The following table lists the GET operation that you can use for Identity API object:
Xero Object
Relative Path to the Object
Connections
/Connections