Xero Practice Manager Endpoint: CustomFields

From OdataLink
Revision as of 17:37, 22 March 2026 by Nic (talk | contribs) (Created page with "= Overview = The Xero Practice Manager '''CustomFields''' endpoint allows you to access a list of all custom fields defined within your Xero Practice Manager. =...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Overview

The Xero Practice Manager CustomFields endpoint allows you to access a list of all custom fields defined within your Xero Practice Manager.

Fields

The following fields are available for the CustomFields endpoint.

DataFile
A record field that identifies the source data file for this record.
UUID
A GUID field representing the internal id of custom field.
Name
A text field that provides the name of the custom field.
UseClient
A true/false value that indicates if the custom field applies to clients.
UseContact
A true/false value that indicates if the custom field applies to contacts.
UseJob
A true/false value that indicates if the custom field applies to jobs.
UseJobTask
A true/false value that indicates if the custom field applies to tasks associated with jobs.
UseJobCost
A true/false value that indicates if the custom field applies to costs associated with jobs.
UseJobTime
A true/false value that indicates if the custom field applies to times associated with jobs.
Type
A text field that indicates the type of input field used to capture the data.
Possible values are:
  • Checkbox
  • Contact Link
  • Date
  • Decimal
  • Dropdown List
  • Heading
  • Link
  • Multi-line Text
  • Number
  • Text
  • Value Link
ValueElement
A text field that indicates the type of type of data stored.
Possible values are:
  • Boolean
  • Date
  • Decimal
  • Number
  • Text


Xero API

For a detailed run through of the endpoint, you can see the Xero API.


Related Endpoints

Clients
ClientsDetails
JobsDetails
JobsDetailsCurrent
JobsSummary
JobsSummaryCurrent
Tasks
Times