GET definition

Example URL:

http://api.workflowmax.com/customfield.api/definition?apiKey=[your API key]&accountKey=[WorkflowMax account key]

Example Response:

<Response>
  <Status>OK</Status> 
  <CustomFieldDefinitions>
    <CustomFieldDefinition>
      <ID>123</ID> 
      <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 -->

      <!-- Identifies XML element for accessing the field value during GET or PUT - valid values are: Text | Decimal | Number | Boolean | Date -->
      <ValueElement />
    </CustomFieldDefinition>
  </CustomFieldDefinitions>
</Response>

GET customfield

Use the following URLs to retrieve custom field data:

Only custom fields containing values will be returned. If a Checkbox field does not contain a value then it is assumed to be false.

Example Response:

<Response>
  <Status>OK</Status> 
  <CustomFields>
    <CustomField>
      <ID>1</ID> 
      <Name>Date Field</Name> 
      <Date>2010-10-11T00:00:00</Date> 
    </CustomField>
    <CustomField>
      <ID>2</ID> 
      <Name>Number Field</Name> 
      <Number>123</Number> 
    </CustomField>
    <CustomField>
      <ID>3</ID> 
      <Name>Decimal Field</Name> 
      <Decimal>123.45</Decimal> 
    </CustomField>
    <CustomField>
      <ID>4</ID> 
      <Name>BooleanField</Name> 
      <Boolean>true</Boolean> 
    </CustomField>
    <CustomField>
      <ID>5</ID> 
      <Name>Date Field</Name> 
      <Text>some text</Text> 
    </CustomField>
  </CustomFields>
</Response>

PUT customfield

Use the following URLs to set/update custom field data:

Example XML Message:

<CustomFields>
  <CustomField>
    <ID>1</ID> 
    <Date>20101011</Date> 
  </CustomField>
  <CustomField>
    <ID>2</ID> 
    <Number>123</Number> 
  </CustomField>
  <CustomField>
    <ID>3</ID> 
    <Decimal>123.45</Decimal> 
  </CustomField>
  <CustomField>
    <ID>4</ID> 
    <Boolean>true</Boolean> 
  </CustomField>
  <CustomField>
    <ID>5</ID> 
    <Text>some text</Text> 
  </CustomField>
</CustomFields>

Example XML Message to clear values of custom fields:

<CustomFields>
  <CustomField>
    <ID>1</ID> 
    <Date /> 
  </CustomField>
  <CustomField>
    <ID>2</ID> 
    <Number /> 
  </CustomField>
  <CustomField>
    <ID>3</ID> 
    <Decimal /> 
  </CustomField>
  <CustomField>
    <ID>5</ID> 
    <Text /> 
  </CustomField>
</CustomFields>

The response will be the standard API Response.

• Overview
• Authentication
• API Response
• API Throttle
• Category Methods
• Client Methods
• Cost Methods
• Custom Field Methods
• Invoice Methods
• Job Methods
• Lead Methods
• Purchase Order Methods
• Quote Methods
• Staff Methods
• Supplier Methods
• Task Methods
• Template Methods
• Time Methods
• Code Sample
• Feedback