Types and Codes


Below is a detailed list of all the types and codes the Xero HQ API uses

Alerts

Target Type

CLIENT When the target is a client
PRACTICE When the target is a Practice

Alert Type

CLIENT_ALERT_TEST Simple alert template to use for initial testing
YOUR_APP_CLIENT_ALERT Predefined custom alert templates. Contact Xero to define one or more of these.

Clients

Status

ACTIVE Indicates that the record is active and current.
ARCHIVED Indicates that the record has been archived.
REPLACED Indicates that the record has been merged and replaced by a new record. Multiple clients may be merged to produce a new client.

Business Structure

PARTNERSHIP
COMPANY
TRUST
CHARITY
LOOK_THROUGH_COMPANY
NOT_FOR_PROFIT
S_CORPORATION
SELF_MANAGED_SUPERANNUATION_FUND
SUPERANNUATION_FUND
CLUB_OR_SOCIETY
PERSON
SOLE_TRADER

Business Identifier Type

ABN An Australian Business Number
REGISTRATION_NUMBER A company registration number.
NZBN A New Zealand Business Number.
ACN An Australian Company Number.

Person Gender

MALE
FEMALE
NOT_KNOWN
NOT_APPLICABLE

Phone Number Types

PHONE
WORK
MOBILE
FAX
DDI
OTHER

Address Types

OTHER
STREET
POSTAL
DELIVERY

Event Category

CLIENT_CREATED Represents the creation of a new client. Published in conjunction with a ORGANISATION_CONNECTED event if the new client is created with a Xero Organisation attached.
CLIENT_UPDATED Represents an update to an existing client. Published in conjunction with a ORGANISATION_CONNECTED or a ORGANISATION_DISCONNECTED event if the update to the client is the addition/removal of the Xero Organisation respectively.
CLIENT_ARCHIVED Represents an active client being archived.
CLIENT_RESTORED Represents an archived client being restored.
CLIENT_REPLACED Represents replacement of an active client. Published in conjunction with a CLIENT_CREATED event for the replacing client.
ORGANISATION_CONNECTED Represents a Xero Organisation being attached to a client. Published in conjunction with a CLIENT_UPDATED event.
ORGANISATION_DISCONNECTED Represents a Xero Organisation being detached from a client. Published in conjunction with a CLIENT_UPDATED event.