Difference between revisions of "Xero Accounting Endpoint: Users"
Jump to navigation
Jump to search
(Created page with "== Overview == The Xero '''Users''' endpoint allows you to access the list of users associated with the Xero Data File. == Fields == The follow...") |
|||
| Line 1: | Line 1: | ||
== Overview == | == Overview == | ||
The Xero '''Users''' [[Endpoints|endpoint]] allows you to access the list of users associated with the [[Data Files|Xero Data File]]. | The Xero '''Users''' [[Xero Accounting Endpoints|endpoint]] allows you to access the list of users associated with the [[Data Files|Xero Data File]]. | ||
== Fields == | == Fields == | ||
| Line 51: | Line 51: | ||
:None | :None | ||
== Related Topics == | |||
:[[Xero Accounting Models]] | |||
:[[Xero Accounting Endpoints]] | |||
Latest revision as of 00:18, 22 September 2021
Overview
The Xero Users endpoint allows you to access the list of users associated with the Xero Data File.
Fields
The following fields are available for the Users endpoint.
- UserID
- A GUID field representing the internal id of a user.
- This field cannot be linked to many endpoints.
- EmailAddress
- A text field provides the unique email address for the user.
- FirstName
- A text field provides the first name of the user.
- LastName
- A text field provides the last name of the user.
- IsSubscriber
- A true/false value that indicates if user is a subscriber.
- OrganisationRole
- A text field provides the role of the user.
- This field determines the permission the user has to the Xero Data File.
- Possible values are:
- READONLY: The user can only read data.
- INVOICEONLY: The user can only record invoices.
- STANDARD: The user is a standard user.
- FINANCIALADVISER: The user has a financial adviser role.
- 'MANAGEDCLIENT: The user has a managed client role (for Partner Edition Only).
- 'CASHBOOKCLIENT: The user has a cashbook client role (for Partner Edition Only).
- UpdatedDateUTC
- A date time field that indicates the last time this record was updated.
Xero API
For a detailed run through of the endpoint, you can see the [developer.xero.com/documentation/api/accounting/users Xero API].
Related Fields
- None
Related Endpoints
- None