All Classes and Interfaces
Class
Description
AccessToken
Account
Account
Account
Account
For bank accounts only.
See Account Class Types
Accounts with a status of ACTIVE can be updated to ARCHIVED.
If this is a system account then this element is returned.
The assigned AccountType
The assigned AccountType
AccountingApi has methods for interacting with all endpoints in the API set
Accounts
Accounts
Accounts
AccountsPayable
AccountsReceivable
See Account Types
See Account Types
AccountUsage
AccountUsageResponse
Action
Status of the action for this organisation
Actions
Address
Address
Address
define the type of address
AddressForOrganisation
define the type of address
Allocation
Allocations
Gets or Sets AllowanceCategory
Gets or Sets AllowanceType
Amount
ApiClient for managing global http client and object mapper
AppStoreApi has methods for interacting with all endpoints in the API set
Asset
AssetApi has methods for interacting with all endpoints in the API set
Assets
See Asset Status Codes.
See Asset Status Codes.
AssetType
Association
Attachment
Attachments
An array to specify multiple currency balances of an account
The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue
amounts, not converted to base currency (read only)
BalanceSheetAccountDetail
BalanceSheetAccountGroup
BalanceSheetAccountType
BalanceSheetResponse
BankAccount
BankAccount
BankAccount
Calculation type for the transaction can be 'Fixed Amount' or 'Balance'
BankFeedsApi has methods for interacting with all endpoints in the API set
BankStatementAccountingResponse
BankStatementResponse
BankTransaction
See Bank Transaction Status Codes
See Bank Transaction Types
BankTransactionResponse
BankTransactions
BankTransfer
BankTransfers
BatchPayment
AUTHORISED or DELETED (read-only).
PAYBATCH for bill payments or RECBATCH for sales invoice payments (read-only)
BatchPaymentDelete
BatchPaymentDeleteByUrlParam
Bank details for use on a batch payment stored with each contact
BatchPayments
Benefit
Benefit
Calculation Type of the employer pension (FixedAmount or PercentageOfGross).
Calculation Type of the superannuation either FixedAmount or PercentageOfTaxableEarnings
Superannuations Category type
Category type of the employer pension
BenefitLine
BenefitObject
Benefits
Bill
BookDepreciationDetail
BookDepreciationSetting
The method of averaging applied to this asset.
See Depreciation Calculation Methods
The method of depreciation applied to this asset.
BrandingTheme
Always INVOICE
BrandingThemes
Budget
Type of Budget.
BudgetBalance
BudgetLine
Budgets
Gets or Sets CalendarType
Calendar type of the pay run
CashAccountResponse
CashBalance
CashflowAccount
CashflowActivity
CashflowResponse
CashflowType
CashValidationResponse
Can be `TIME`, `FIXED` or `NON_CHARGEABLE`, defines how the task
will be charged.
CISOrgSetting
CISOrgSettings
CISSetting
CISSettings
Connection
Contact
Current status of a contact – see contact status types
The default purchases line amount type for a contact Only available when summaryOnly parameter
or paging is used, or when fetch by ContactId or ContactNumber.
The default sales line amount type for a contact.
ContactDetail
ContactGroup
The Status of a contact group.
ContactGroups
ContactPerson
ContactResponse
Contacts
ContactTotalDetail
ContactTotalOther
Balance supplied for each account that has a value as at the conversion date.
The date when the organisation starts using Xero
Gets or Sets CountryCode
ISO-3166 alpha-2 country code, e.g.
Country of residence as a valid ISO 3166-1 alpha-2 country code e.g.
CourtOrderLine
Data transfer object for public create usage end point
If the statement balances are credit or debit, the CreditDebitIndicator should be specified from
the perspective of the Customer.
CreditNote
See Credit Note Status Codes
See Credit Note Types
CreditNoteResponse
CreditNotes
Currencies
Currency
3 letter alpha code for the currency – see list of currency codes
3 letter alpha code for the ISO-4217 currency code, e.g.
3 letter alpha code for the ISO-4217 currency code, e.g.
CurrentStatementResponse
DataSourceResponse
Deduction
Deduction
determine the calculation type whether fixed amount or percentage of gross
Deduction Category type
Deduction Category type
DeductionLine
DeductionLine
DeductionLine
DeductionObject
DeductionObject
Deductions
Deductions
DeductionType
Gets or Sets deductionCategory
Gets or Sets DeductionTypeCalculationType
EarningsLine
EarningsLine
EarningsLine
EarningsOrder
EarningsOrder
EarningsOrderObject
EarningsOrderObject
EarningsOrders
EarningsOrders
EarningsRate
EarningsRate
EarningsRate
Indicates how an employee will be paid when taking this type of earning
Indicates how an employee will be paid when taking this type of earning
Indicates the type of the earning rate
Indicates the type of the earning rate
Gets or Sets EarningsRateCalculationType
EarningsRateObject
EarningsRateObject
EarningsRates
EarningsRates
EarningsTemplate
EarningsTemplate
EarningsTemplateObject
EarningsTemplateObject
Gets or Sets EarningsType
Element
Employee
Employee
Employee
Employee
The employee’s gender.
The employee’s gender
The employee’s gender
Current status of an employee – see contact status types
* `V` Voluntary cessation - An employee resignation, retirement, domestic or pressing
necessity or abandonment of employment * `I` Ill health - An employee resignation due
to medical condition that prevents the continuation of employment, such as for illness,
ill-health, medical unfitness or total permanent disability * `D` Deceased - The
death of an employee * `R` Redundancy - An employer-initiated termination of
employment due to a genuine redundancy or approved early retirement scheme * `F`
Dismissal - An employer-initiated termination of employment due to dismissal, inability to
perform the required work, misconduct or inefficiency * `C` Contract cessation - The
natural conclusion of a limited employment relationship due to contract/engagement duration or
task completion, seasonal work completion, or to cease casuals that are no longer required *
`T` Transfer - The administrative arrangements performed to transfer employees across
payroll systems, move them temporarily to another employer (machinery of government for public
servants), transfer of business, move them to outsourcing arrangements or other such technical
activities.
EmployeeEarningsTemplates
EmployeeLeave
EmployeeLeave
EmployeeLeaveBalance
EmployeeLeaveBalance
EmployeeLeaveBalances
EmployeeLeaveBalances
EmployeeLeaveObject
EmployeeLeaveObject
EmployeeLeaves
EmployeeLeaves
EmployeeLeaveSetup
EmployeeLeaveSetupObject
EmployeeLeaveType
EmployeeLeaveType
The schedule of accrual
The schedule of accrual
EmployeeLeaveTypeObject
EmployeeLeaveTypeObject
EmployeeLeaveTypes
EmployeeLeaveTypes
EmployeeObject
EmployeeObject
EmployeeOpeningBalance
EmployeeOpeningBalances
EmployeeOpeningBalancesObject
EmployeeOpeningBalancesObject
EmployeePayTemplate
EmployeePayTemplate
EmployeePayTemplateObject
EmployeePayTemplateObject
EmployeePayTemplates
EmployeePayTemplates
Employees
Employees
Employees
Employees
Employee Status Types
EmployeeStatutoryLeaveBalance
EmployeeStatutoryLeaveBalance
The type of statutory leave
The type of statutory leave
The units will be \"Hours\"
The units will be \"Hours\"
EmployeeStatutoryLeaveBalanceObject
EmployeeStatutoryLeaveBalanceObject
EmployeeStatutoryLeavesSummaries
EmployeeStatutoryLeavesSummaries
EmployeeStatutoryLeaveSummary
EmployeeStatutoryLeaveSummary
The status of the leave
The status of the leave
The category of statutory leave
The category of statutory leave
EmployeeStatutorySickLeave
EmployeeStatutorySickLeave
Gets or Sets entitlementFailureReasons
Gets or Sets entitlementFailureReasons
EmployeeStatutorySickLeaveObject
EmployeeStatutorySickLeaveObject
EmployeeStatutorySickLeaves
EmployeeStatutorySickLeaves
EmployeeTax
EmployeeTax
Contribution Option which can be 'MakeContributions' 'OptOut',
'OnAContributionsHoliday', 'OnASavingsSuspension',
'NotCurrentlyAKiwiSaverMember' for employees without a KiwiSaver membership
EmployeeTaxObject
EmployeeTaxObject
EmployeeWorkingPattern
EmployeeWorkingPatternsObject
EmployeeWorkingPatternWithWorkingWeeks
EmployeeWorkingPatternWithWorkingWeeksObject
EmployeeWorkingPatternWithWorkingWeeksRequest
Employment
Employment
The NI Category of the employee
Gets or Sets EmploymentBasis
EmploymentObject
EmploymentObject
Gets or Sets EmploymentTerminationPaymentType
Gets or Sets EmploymentType
The StartBalance plus all the Statement Line Amounts should be equal to the EndBalance Amount.
Gets or Sets EntitlementFinalPayPayoutType
Error
Error
On error, the API consumer will receive an HTTP response with a HTTP Status Code of 4xx or 5xx
and a Content-Type of application/problem+json.
Error
Identifies the type of error.
ExpenseClaim
Current status of an expense claim – see status types
ExpenseClaims
ExternalLink
See External link types
FeedConnection
High level bank account type - BANK CREDITCARD BANK encompasses all bank account types other
than credit cards.
the current status of the feed connection
FeedConnections
FieldValidationErrorsElement
FileObject
Files
FilesApi has methods for interacting with all endpoints in the API set
FinanceApi has methods for interacting with all endpoints in the API set
Folder
Folders
GrossEarningsHistory
HistoryRecord
HistoryRecordResponse
HistoryRecords
HomeAddress
IdentityApi has methods for interacting with all endpoints in the API set
A summary of the import from setup endpoint
A summary of the accounts changes
ImportSummaryObject
ImportSummaryOrganisation
IncomeByContactResponse
Gets or Sets IncomeType
InvalidField
InvalidField
Invoice
See Invoice Status Codes
See Invoice Types
InvoiceAddress
Indicates whether the address is defined as origin (FROM) or destination (TO)
InvoiceReminder
InvoiceReminders
InvoiceResponse
Invoices
Item
Items
Journal
The journal source type.
JournalLine
Journals
LeaveAccrualLine
LeaveAccrualLine
LeaveAccrualLine
LeaveApplication
LeaveApplications
LeaveBalance
Code used to identify the Leave Category
LeaveEarningsLine
LeaveEarningsLine
LeaveEarningsLine
LeaveLine
Calculation type for leave line for Opening Balance on Employee
The leave type lines
LeavePeriod
LeavePeriod
LeavePeriod
Period Status
Period Status
LeavePeriods
LeavePeriods
Gets or Sets LeavePeriodStatus
LeaveType
LeaveType
LeaveType
Gets or Sets LeaveTypeContributionType
LeaveTypeObject
LeaveTypeObject
LeaveTypes
LeaveTypes
Line amounts are exclusive of tax by default if you don’t specify this element.
LineItem
The type of taxability
LineItemItem
LineItemResponse
LineItemTracking
LinkedTransaction
The Type of the source tranasction.
Filter by the combination of ContactID and Status.
This will always be BILLABLEEXPENSE.
LinkedTransactions
LockHistoryModel
LockHistoryResponse
ManualJournal
See Manual Journal Status Codes
ManualJournalLine
ManualJournals
ManualJournalTotal
Gets or Sets ManualTaxType
The object returned for a bad request
The Object Group that the object is in.
The Object Type
OnlineInvoice
OnlineInvoices
OpeningBalances
Organisation
BUSINESS or PARTNER.
Organisation Entity Type
Organisation Type
Organisation Classes describe which plan the Xero organisation is on (e.g.
The accounting basis used for tax returns.
The frequency with which tax returns are processed.
See Version Types
Organisations
Overpayment
See Overpayment Status Codes
See Overpayment Types
OverpaymentResponse
Overpayments
Pagination
Pagination
Pagination
Pagination
Pagination
Pagination
PaidLeaveEarningsLine
PayItem
PayItems
Payment
See Payment Types.
The status of the payment.
PaymentDelete
Gets or Sets PaymentFrequencyType
PaymentLine
PaymentLine
PaymentMethod
PaymentMethod
The payment method code
The payment method code
PaymentMethodObject
PaymentMethodObject
PaymentResponse
Payments
PaymentService
PaymentServices
PaymentTerm
Gets or Sets PaymentTermType
How the requested leave will be paid out, e.g.
PayrollAuApi has methods for interacting with all endpoints in the API set
PayrollCalendar
PayrollCalendars
PayrollNzApi has methods for interacting with all endpoints in the API set
PayrollUkApi has methods for interacting with all endpoints in the API set
PayRun
PayRun
PayRun
Calendar type of the pay run
Pay run status
Pay run status
Pay run type
Pay run type
PayRunCalendar
PayRunCalendar
Type of the calendar
PayRunCalendarObject
PayRunCalendarObject
PayRunCalendars
PayRunCalendars
PayRunObject
PayRunObject
PayRuns
PayRuns
PayRuns
Gets or Sets PayRunStatus
Payslip
Payslip
PaySlip
The payment method code
The payment method code
PayslipLines
PayslipObject
PayslipObject
PaySlipObject
Payslips
Payslips
PaySlips
PayslipSummary
PayTemplate
Phone
Gets or Sets phoneType
Plan
Status of the plan.
PnlAccount
PnlAccountClass
PnlAccountType
PracticeResponse
Prepayment
See Prepayment Status Codes
See Prepayment Types
PrepaymentResponse
Prepayments
Price
Problem
The object returned for a bad request
The object returned for a bad request
ProblemDetails
Gets or Sets ProblemType
Product
The pricing model of the product: * FIXED: Customers are charged a fixed amount for each
billing period * PER_SEAT: Customers are charged based on the number of units they purchase *
METERED: Customers are charged per use of this product
ProfitAndLossResponse
Project
ProjectApi has methods for interacting with all endpoints in the API set
ProjectCreateOrUpdate
ProjectPatch
Projects
Status for project
ProjectUser
ProjectUsers
Purchase
PurchaseOrder
See Purchase Order Status Codes
PurchaseOrders
Quote
Line amounts are exclusive of tax by default if you don’t specify this element.
Quotes
The status of the quote.
Gets or Sets RateType
Receipt
Current status of receipt – see status types
Receipts
RefreshToken
Reimbursement
Reimbursement
See Calculation Types
See Reimbursement Categories
Optional Type Of Units.
ReimbursementLine
ReimbursementLine
ReimbursementLine
The reimbursement type lines
ReimbursementObject
ReimbursementObject
Reimbursements
Reimbursements
ReimbursementType
RepeatingInvoice
One of the following - DRAFT or AUTHORISED – See Invoice Status Codes
See Invoice Types
RepeatingInvoices
Report
See Prepayment Types
ReportAttribute
ReportCell
ReportFields
ReportHistoryModel
ReportHistoryResponse
ReportRow
ReportRows
Reports
ReportWithRow
ReportWithRows
RequestEmpty
Gets or Sets ResidencyStatus
ResourceValidationErrorsElement
RFC3339DateFormat method for serializing date into milliseconds
Gets or Sets RowType
SalaryAndWage
SalaryAndWage
The type of the payment of the corresponding salary and wages
The type of the payment of the corresponding salary and wages
The current status of the corresponding salary and wages
The current status of the corresponding salary and wages
The type of the Working Pattern of the corresponding salary and wages
SalaryAndWageObject
SalaryAndWageObject
SalaryAndWages
SalaryAndWages
SalesTrackingCategory
Schedule
the payment terms
One of the following - WEEKLY or MONTHLY
Gets or Sets SeniorMaritalStatus
Setting
Settings
Settings
Settings
SettingsObject
Tracking categories for Employees and Timesheets
The tracking category used for employees
The tracking category used for timesheets
Setup
The starting balance of the statement
State abbreviation for employee home address
Statement
Current status of statements
StatementBalanceResponse
the lines details for a statement
StatementLineResponse
StatementLinesResponse
StatementResponse
Statements
StatutoryDeduction
StatutoryDeduction
Statutory Deduction Category
Statutory Deduction Category
StatutoryDeductionLine
StatutoryDeductionObject
StatutoryDeductions
StringUtil has helper methods for String and Date conversions
Subscription
Status of the subscription.
SubscriptionItem
Status of the subscription item.
Gets or Sets SuperannuationCalculationType
Gets or Sets SuperannuationContributionType
SuperannuationLine
SuperannuationLine
SuperannuationObject
Superannuations
SuperFund
SuperFundProduct
SuperFundProducts
SuperFunds
Gets or Sets SuperFundType
SuperLine
SuperMembership
Task
Status of the task.
TaskCreateOrUpdate
Tasks
TaxBreakdownComponent
The type of the jurisdiction
Tax codes used for employee tax
TaxComponent
TaxDeclaration
TaxLine
TaxLine
TaxLine
TaxRate
See ReportTaxTypes
See Status Codes
TaxRates
Gets or Sets TaxScaleType
TaxSettings
The type of period (\"weeks\" or \"months\")
See Tax Types – can only be used on update calls
TenNinetyNineContact
Contact federal tax classification
Gets or Sets TFNExemptionType
TimeEntries
TimeEntry
Status of the time entry.
TimeEntryCreateOrUpdate
Timesheet
Timesheet
Timesheet
Status of the timesheet
Status of the timesheet
TimesheetEarningsLine
TimesheetEarningsLine
TimesheetLine
TimesheetLine
TimesheetLine
TimesheetLineObject
TimesheetLineObject
TimesheetObject
TimesheetObject
TimesheetObject
Timesheets
Timesheets
Timesheets
Gets or Sets TimesheetStatus
Timezone specifications
TotalDetail
TotalOther
TrackingCategories
TrackingCategories
TrackingCategories
TrackingCategory
TrackingCategory
TrackingCategory
The status of a tracking category
TrackingOption
The status of a tracking option
TrackingOptions
TrialBalanceAccount
TrialBalanceEntry
TrialBalanceMovement
TrialBalanceResponse
Data transfer object for public update usage end point
UsageRecord
Response to get usage record
User
User
User role that defines permissions in Xero and via API (READONLY, INVOICEONLY, STANDARD,
FINANCIALADVISER, etc)
UserActivitiesResponse
UserResponse
Users
ValidationError
ValidationError
Gets or Sets WorkCondition
WorkingWeek
Legacy XeroApiException general exception class for returning exception details
XeroApiExceptionHandler main method for handling and throwing errors returned by Xero API
handle app and minute rate limit exception
Base authentication exception all other Xero authentication exceptions should extend.
handle bad request exception
handle bank feed conflict exception
handle daily rate limit exception
Base application exception all other Xero exceptions should extend.
handle forbidden exception
handle method not allowed exception
handle minute rate limit exception
handle not available exception
handle not found exception
handle not available exception
Base application exception all other rate limit Xero exceptions should extend
handle server error exception
handle unauthorized exception