CustomField

Version: 1.33

customField is optional in Gotransverse. Custom Fields are created, disabled or enabled in the graphical user interface (GUI). See the GUI documentation for Managing Custom Fields.

Create Custom Fields in the GUI and define their CustomFieldType to use them in the SalesOrder, on an OrderItem, or on the BillingAccount, or Service. Use Custom Fields for different types of data such as text, a list of defined values, and so forth, during the SalesOrder and the creation of a BillingAccount, or later, on the BillingAccount or on the Service.

For example, when the CustomField is enabled, all Orders or new Billing Accounts created, have that Custom Field and any information entered in that Custom Field (the information is the CustomFieldValue). The Custom Fields and their content, the CustomFieldValues, are shown on certain reports.These entities are related to Gotransverse system settings for your tenant and Gotransverse API queries and faults.

Also refer to the following topics for CustomFieldValue:

AddCustomFieldValueToBillingAccount
RemoveCustomFieldValueFromBillingAccount
AddCustomFieldValueToOrder
RemoveCustomFieldValueFromOrder
AddCustomFieldValueToService
RemoveCustomFieldValueFromService

In the GUI, if the Custom Fields are disabled, they are hidden but they and their information are not deleted. Custom Fields can not be deleted.

Query and view the Custom Fields through the GUI or API. Through the API, CustomField can be queried directly and can also be queried through CustomFieldValue.

You cannot create, enable, or disable Custom Fields through the API, only query and use them.

Perform through the GUI

CREATE the Custom Fields (click on the following link to the GUI page for Managing Custom Fields)
Enable Custom Fields
Disable Custom Fields (keeps existing data but hides fields)
View list of Custom Fields
Use the Custom Field by adding data (CustomFieldValue) during the SalesOrder
Use the Custom Field by adding data (CustomFieldValue) to the (Billing)Account
Use the Custom Field by adding data (CustomFieldValue) to the Service

Perform through the API

Query and view the list of Custom Fields
Select and use the Custom Field by adding data (CustomFieldValue) during the SalesOrder.
Use Custom Fields by adding data (CustomFieldValue) to a SalesOrder.
Use Custom Fields by removing data (CustomFieldValue) from a SalesOrder Custom field.
Use Custom Fields by adding data (CustomFieldValue) to an existing BillingAccount (refer to AddCustomFieldValueToBillingAccount).
Use Custom Fields by removing data (CustomFieldValue) from a BillingAccount Custom field (refer to RemoveCustomFieldValueFromBillingAccount).
Use Custom Fields by adding data (CustomFieldValue) to an existing Service (refer to AddCustomFieldValueToService).
Use Custom Fields by removing data (CustomFieldValue) from an existing Service Custom Field (refer to RemoveCustomFieldValueFromService).

Parameters

Each CustomField shown from the query shows information for a number of elements in the entity. The following table shows the elements, details of the elements, and brief descriptions.

Elements
Element Name	Query Key	Element Type	Field Length	Description
queryScope		QueryScope	- -	Whether default query results are overridden by QueryScope resulting in SHALLOW or DEEP query results. Refer to QueryScope for details.
eid	Y	Long	System Generated	System generated unique identity number assigned to the Agreement.
customFieldType	Y	CustomFieldType	- -	The type of the CustomField: ORDER or BILLING_ACCOUNT
name	Y	String	40	The name of the CustomField.
description		String	255	A description of the purpose of the Custom Field.
enabled	Y	Boolean	Select either: "true" (Yes) or "false" (No)	Is the Custom Field enabled? YES, the Custom Field is enabled, can be used, and is shown during the SalesOrder. NO, the Custom Field is NOT enabled, cannot be used, and is not shown during the SalesOrder. The data in the field is maintained and can be used again when the field is enabled at a later date.
searchable	Y	Boolean	Select either: "true" (Yes) or "false" (No)	Is the Custom Field searchable? YES, the Custom Field is searchable. NO, the Custom Field is NOT searchable.
fieldType		FieldType	- -	See FieldType for selection.

Entity Custom Fields

The entity CustomFields enables you to see multiple pages of the entity CustomField.

Elements
Element Name	Element Type	Field Length	Description
pageNumber	Integer	as needed	Shows the current page number.
pageSize	Integer	as needed	Shows the page size.
totalElements	Long	as needed	Shows the total number of items found.
elementCount	Integer	as needed	Shows the current count of the item in the number of items that were found.
totalPages	Integer	as needed	Shows the total number of pages.
customField	CustomField	- -	Shows the list of CustomFields.

Information for the related entity of CustomFields:

Entity CustomFields

See All Custom Fields

To get a list of all of your CustomFields without knowing their EIDs:

Query
Query to Use	Query for	Returns
SimpleDataQuery	CustomField	Complete list of all of the CustomFields.

SOAP Example Query and Response

The following SOAP example is a general query for all Custom Fields your company is using and shows the first 50 of them:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns2:query xmlns="http://www.tractbilling.com/billing/1_31/domain" xmlns:ns2="http://www.tractbilling.com/billing/1_31/service">
            <ns2:queryRequest>
                <simpleDataQuery startIndex="0" size="50">
                    <type>CustomField</type>
                </simpleDataQuery>
            </ns2:queryRequest>
        </ns2:query>
    </soap:Body>
</soap:Envelope>

This was the response (the company was using 1 Custom Field named "Membership Smith Business Association"):

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns2:queryResponse xmlns="http://www.tractbilling.com/billing/1_31/domain" xmlns:ns2="http://www.tractbilling.com/billing/1_31/service">
            <ns2:return successful="true">
                <customFields pageNumber="1" pageSize="50" totalElements="1" elementCount="1" totalPages="1">
                    <customField customFieldType="BillingAccount" 
name="Membership Smith Business Association" 
description="Is this Customer a member of the separate Smith Business Association or not?" 
enabled="true" eid="21"/>
                </customFields>
            </ns2:return>
        </ns2:queryResponse>
    </soap:Body>
</soap:Envelope>

This was the response from a different company that had no Custom Fields in use:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns2:queryResponse xmlns="http://www.tractbilling.com/billing/1_31/domain" xmlns:ns2="http://www.tractbilling.com/billing/1_31/service">
            <ns2:return successful="true">
                <customFields pageNumber="1" pageSize="50" totalElements="0" elementCount="0" totalPages="0"/>
            </ns2:return>
        </ns2:queryResponse>
    </soap:Body>
</soap:Envelope>

SOAP Example Query by Enabled

The following SOAP example is a specific query of all Custom Fields for the Custom Field that are enabled. Custom Fields not enabled would not be included in the results.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:ser="http://www.tractbilling.com/billing/1_31/service">
    <soapenv:Header/>
    <soapenv:Body>
        <ser:query>
            <!-- Optional: -->
            <ser:queryRequest>
                <dom:simpleDataQuery pageSize="50" pageNumber="1">
                    <dom:type>CustomField</dom:type>
                    <dom:parameter parameter="enabled" parameterValue="true" />
                </dom:simpleDataQuery>
            </ser:queryRequest>
        </ser:query>
    </soapenv:Body>
</soapenv:Envelope>

SOAP Example Query by Specific Name

The following SOAP example is a specific query of all Custom Fields for the Custom Field that has the name "Type of Membership."

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:ser="http://www.tractbilling.com/billing/1_31/service">
    <soapenv:Header/>
    <soapenv:Body>
        <ser:query>
            <!-- Optional: -->
            <ser:queryRequest>
                <dom:simpleDataQuery pageSize="50" pageNumber="1">
                    <dom:type>CustomField</dom:type>
                    <dom:parameter parameter="name" parameterValue="Type of Membership" />
                </dom:simpleDataQuery>
            </ser:queryRequest>
        </ser:query>
    </soapenv:Body>
</soapenv:Envelope>

REST Mount Point and Parameters

Use the following mount points for CustomFields:

GET https://my.tractbilling.com/t/s/r/1.33/customFields
GET https://my.tractbilling.com/t/s/r/1.33/customFields/<eid>
GET https://my.tractbilling.com/t/s/r/1.33/customFields?eid=<eid>
GET https://my.tractbilling.com/t/s/r/1.33/customFields?name=<name>
GET https://my.tractbilling.com/t/s/r/1.33/customFields?enabled=<enabled>
GET https://my.tractbilling.com/t/s/r/1.33/customFields?type=<type>
GET https://my.tractbilling.com/t/s/r/1.33/customFields?searchable=<searchable>

REST Example Query and Response

The following general query provided the following response:

GET https://my.tractbilling.com/t/s/r/1.33/customFields

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<customFields xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain" pageNumber="1" pageSize="50" totalElements="1" elementCount="1" totalPages="1">
    <ns2:customField customFieldType="BillingAccount" 
name="Membership Smith Business Association" 
description="Is this Customer a member of the separate Smith Business Association or not?" 
enabled="true" eid="21"/>
</customFields>