Xero Practice Manager Endpoint: CustomFields: Difference between revisions
Jump to navigation
Jump to search
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. =..." |
No edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 35: | Line 35: | ||
:A [[Field Type: Text|text field]] that indicates the type of input field used to capture the data. | :A [[Field Type: Text|text field]] that indicates the type of input field used to capture the data. | ||
:Possible values are: | :Possible values are: | ||
* Checkbox | :* Checkbox | ||
* Contact Link | :* Contact Link | ||
* Date | :* Date | ||
* Decimal | :* Decimal | ||
* Dropdown List | :* Dropdown List | ||
* Heading | :* Heading | ||
* Link | :* Link | ||
* Multi-line Text | :* Multi-line Text | ||
* Number | :* Number | ||
* Text | :* Text | ||
* Value Link | :* Value Link | ||
;ValueElement | ;ValueElement | ||
:A [[Field Type: Text|text field]] that indicates the type of type of data stored. | :A [[Field Type: Text|text field]] that indicates the type of type of data stored. | ||
:Possible values are: | :Possible values are: | ||
* Boolean | :* Boolean | ||
* Date | :* Date | ||
* Decimal | :* Decimal | ||
* Number | :* Number | ||
* Text | :* Text | ||
| Line 66: | Line 66: | ||
:[[Xero Practice Manager Endpoint: Clients|Clients]] | :[[Xero Practice Manager Endpoint: Clients|Clients]] | ||
:[[Xero Practice Manager Endpoint: ClientsDetails|ClientsDetails]] | :[[Xero Practice Manager Endpoint: ClientsDetails|ClientsDetails]] | ||
:[[Xero Practice Manager Endpoint: GetCustomFieldsClient|GetCustomFieldsClient]] | |||
:[[Xero Practice Manager Endpoint: GetCustomFieldsContact|GetCustomFieldsContact]] | |||
:[[Xero Practice Manager Endpoint: GetCustomFieldsJob|GetCustomFieldsJob]] | |||
:[[Xero Practice Manager Endpoint: GetCustomFieldsJobTask|GetCustomFieldsJobTask]] | |||
:[[Xero Practice Manager Endpoint: GetCustomFieldsTime|GetCustomFieldsTime]] | |||
:[[Xero Practice Manager Endpoint: JobsDetails|JobsDetails]] | :[[Xero Practice Manager Endpoint: JobsDetails|JobsDetails]] | ||
:[[Xero Practice Manager Endpoint: JobsDetailsCurrent|JobsDetailsCurrent]] | :[[Xero Practice Manager Endpoint: JobsDetailsCurrent|JobsDetailsCurrent]] | ||
| Line 72: | Line 77: | ||
:[[Xero Practice Manager Endpoint: Tasks|Tasks]] | :[[Xero Practice Manager Endpoint: Tasks|Tasks]] | ||
:[[Xero Practice Manager Endpoint: Times|Times]] | :[[Xero Practice Manager Endpoint: Times|Times]] | ||
== Change Logs == | |||
* '''2026-03-23''': Endpoint added. | |||
Latest revision as of 18:56, 22 March 2026
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
- GetCustomFieldsClient
- GetCustomFieldsContact
- GetCustomFieldsJob
- GetCustomFieldsJobTask
- GetCustomFieldsTime
- JobsDetails
- JobsDetailsCurrent
- JobsSummary
- JobsSummaryCurrent
- Tasks
- Times
Change Logs
- 2026-03-23: Endpoint added.