With our community of partners, you can get expert advice and training so you can be up and running in no time!
View setup partnersWith our community of partners, you can get expert advice and training so you can be up and running in no time!
View setup partnersGet the Guide on Moving from spreadsheets to software.
Want to join us? Become a partner.
No credit card required. No contracts to cancel. No setup fees. No hidden costs. No downloads.
Method | Description |
---|---|
GET definition | Return a list of all the custom fields |
GET customfield | Retrieve custom field data for a specific client, contact, supplier, supplier contact, job or lead |
PUT customfield | Update custom field data for a specific client, contact, supplier, supplier contact, job or lead |
Return a list of all the custom fields
https://api.xero.com/workflowmax/3.0/customfield.api/definition
<Response>
<Status>OK</Status>
<CustomFieldDefinitions>
<CustomFieldDefinition>
<UUID>e873137a-7e07-49a0-8987-130e7418ad34</UUID>
<Name>Name of Custom Field</Name>
<Type /> <!-- e.g. Text, Decimal, Date, Dropdown List, Value Link, etc -->
<LinkUrl /> <!-- Optional - URL for Value Link field types -->
<Options /> <!-- Optional - Options for Dropdown lists -->
<!-- The following elements indicate if the field is used for clients, contacts, suppliers, jobs and/or leads -->
<UseClient>false</UseClient> <!-- true | false -->
<UseContact>false</UseContact> <!-- true | false -->
<UseSupplier>false</UseSupplier> <!-- true | false -->
<UseJob>false</UseJob> <!-- true | false -->
<UseLead>false</UseLead> <!-- true | false -->
<UseJobTask>false</UseJobTask> <!-- true | false -->
<UseJobCost>false</UseJobCost> <!-- true | false -->
<UseJobTime>false</UseJobTime> <!-- true | false -->
<!-- Identifies XML element for accessing the field value during GET or PUT - valid values are: Text | Decimal | Number | Boolean | Date -->
<ValueElement />
</CustomFieldDefinition>
</CustomFieldDefinitions>
</Response>
Retrieve custom field data for a specific client, contact, supplier, supplier contact, job or lead
Use the following URLs to retrieve custom field data:
Type | URL |
---|---|
Client | GET https://api.xero.com/workflowmax/3.0/client.api/get/[identifier]/customfield |
Contact | GET https://api.xero.com/workflowmax/3.0/client.api/contact/[identifier]/customfield |
Supplier | GET https://api.xero.com/workflowmax/3.0/supplier.api/get/[identifier]/customfield |
Supplier Contact | GET https://api.xero.com/workflowmax/3.0/supplier.api/contact/[identifier]/customfield |
Job | GET https://api.xero.com/workflowmax/3.0/job.api/get/[identifier]/customfield |
Job Task | GET https://api.xero.com/workflowmax/3.0/job.api/task/[identifier]/customfield |
Job Cost | GET https://api.xero.com/workflowmax/3.0/job.api/cost/[identifier]/customfield |
Time | GET https://api.xero.com/workflowmax/3.0/time.api/get/[identifier]/customfield |
Lead | GET https://api.xero.com/workflowmax/3.0/lead.api/get/[identifier]/customfield |
Only custom fields containing values will be returned. If a Checkbox field does not contain a value then it is assumed to be false. |
<Response>
<Status>OK</Status>
<CustomFields>
<CustomField>
<UUID>614e4a45-b462-4857-a33d-d241249e42b6</UUID>
<Name>Date Field</Name>
<Date>2010-10-11T00:00:00</Date>
</CustomField>
<CustomField>
<UUID>4dde4b80-5ae7-4b5b-b97e-80200653343a</UUID>
<Name>Number Field</Name>
<Number>123</Number>
</CustomField>
<CustomField>
<UUID>daef97b8-0343-42e1-9f0c-d0a5d068ad1c</UUID>
<Name>Decimal Field</Name>
<Decimal>123.45</Decimal>
</CustomField>
<CustomField>
<UUID>8dbe4992-cd27-4c85-a2da-f846e49d0179</UUID>
<Name>Boolean Field</Name>
<Boolean>true</Boolean>
</CustomField>
<CustomField>
<UUID>d6c62806-b868-4dc8-8931-7fc4039bc481</UUID>
<Name>Date Field</Name>
<Text>some text</Text>
</CustomField>
</CustomFields>
</Response>
Update custom field data for a specific client, contact, supplier, supplier contact, job or lead
Use the following URLs to set/update custom field data:
Type | URL |
---|---|
Client | PUT https://api.xero.com/workflowmax/3.0/client.api/update/[identifier]/customfield |
Contact | PUT https://api.xero.com/workflowmax/3.0/client.api/contact/[identifier]/customfield |
Supplier | PUT https://api.xero.com/workflowmax/3.0/supplier.api/get/[identifier]/customfield |
Supplier Contact | PUT https://api.xero.com/workflowmax/3.0/supplier.api/contact/[identifier]/customfield |
Job | PUT https://api.xero.com/workflowmax/3.0/job.api/update/[identifier]/customfield |
Job Task | PUT https://api.xero.com/workflowmax/3.0/job.api/task/[identifier]/customfield |
Job Cost | PUT https://api.xero.com/workflowmax/3.0/job.api/cost/[identifier]/customfield |
Time | PUT https://api.xero.com/workflowmax/3.0/time.api/update/[identifier]/customfield |
Lead | PUT https://api.xero.com/workflowmax/3.0/lead.api/update/[identifier]/customfield |
Only custom fields containing values will be returned. If a Checkbox field does not contain a value then it is assumed to be false.
<CustomFields>
<CustomField>
<UUID>614e4a45-b462-4857-a33d-d241249e42b6</UUID>
<Date>20101011</Date>
</CustomField>
<CustomField>
<UUID>4dde4b80-5ae7-4b5b-b97e-80200653343a</UUID>
<Number>123</Number>
</CustomField>
<CustomField>
<UUID>daef97b8-0343-42e1-9f0c-d0a5d068ad1c</UUID>
<Decimal>123.45</Decimal>
</CustomField>
<CustomField>
<UUID>8dbe4992-cd27-4c85-a2da-f846e49d0179</UUID>
<Boolean>true</Boolean>
</CustomField>
<CustomField>
<UUID>d6c62806-b868-4dc8-8931-7fc4039bc481</UUID>
<Text>some text</Text>
</CustomField>
</CustomFields>
<CustomFields>
<CustomField>
<UUID>614e4a45-b462-4857-a33d-d241249e42b6</UUID>
<Date />
</CustomField>
<CustomField>
<UUID>4dde4b80-5ae7-4b5b-b97e-80200653343a</UUID>
<Number />
</CustomField>
<CustomField>
<UUID>daef97b8-0343-42e1-9f0c-d0a5d068ad1c</UUID>
<Decimal />
</CustomField>
<CustomField>
<UUID>d6c62806-b868-4dc8-8931-7fc4039bc481</UUID>
<Text />
</CustomField>
</CustomFields>
The response will be the standard API Response.