CustomFieldValue

Version: 1.33

CustomFieldValue is optional in Gotransverse. CustomFieldValue is the content in a CustomField. Custom fields are created and managed in the Gotransverse Setup module.

Used In: BillingAccount, Service, OrderItem, SalesOrder, and RenewalOrder.

Commands: AddCustomFieldValueToBillingAccount, AddCustomFieldValueToOrder, AddCustomFieldValueToService, RemoveCustomFieldValueFromBillingAccount, RemoveCustomFieldValueFromOrder, RemoveCustomFieldValueFromService.

Custom Field Values can be different types of data such as text, a list of defined values, and so forth, and depending on the type of Custom field the content for the Custom field is entered in different work flows. For example, if the Custom field is a Sales Order Customer field, then the content is entered during the SalesOrder. The Custom fields and their information of Custom Field Values, are shown on certain reports. Custom fields cannot be deleted.

Parameters
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 CustomFieldValue.
customField		CustomField	- -	The custom field associated with this custom field value.
value	Y	String	255	The information in the field.

Query a CustomFieldValue

Query Key Parameters - CustomFieldValue
Query Key	Value	Definition
eid	Long	The eid number of the CustomFieldValue.
billingAccountEid	Long	The eid number of the BillingAccount.
accountNum	String	The Billing Account number.
externalAccountNum	String	The Billing Account's external number (if there is one).
customFieldEid	String	The eid number of the CustomField.
customFieldName	Long	The name of the CustomField.
orderEid	Long	The eid number of the Order.
orderNum	String	The Order Number.
value	String	The content of the CustomField.
serviceEid	Long	The eid number of the Service.
orderItemEid	Long	The eid number of the OrderItem.

Query To Use
Query to Use	Query for	Parameter Name and Value	Returns
SimpleDataQuery	CustomFieldValue	<parameter name><parameter value>	Complete list of all of the CustomFieldValues.

Use customFieldValues to retrieve paged results.

REST Endpoints

PUT https://my.tractbilling.com/t/s/r/1.33/customFieldValues/<eid> GET https://my.tractbilling.com/t/s/r/1.33/customFieldValues
GET https://my.tractbilling.com/t/s/r/1.33/customFieldValues/<eid> GET https://my.tractbilling.com/t/s/r/1.33/customFieldValues?eid=<eid>
GET https://my.tractbilling.com/t/s/r/1.33/customFieldValues?accountNum=<accountNum>
GET https://my.tractbilling.com/t/s/r/1.33/customFieldValues?billingAccountEid=<billingAccountEid>
GET https://my.tractbilling.com/t/s/r/1.33/customFieldValues?externalAccountNum=<externalAccountNum>
GET https://my.tractbilling.com/t/s/r/1.33/customFieldValues?customFieldEid=<customFieldEid>
GET https://my.tractbilling.com/t/s/r/1.33/customFieldValues?customFieldName=<customFieldName>
GET https://my.tractbilling.com/t/s/r/1.33/customFieldValues?value=<value>
GET https://my.tractbilling.com/t/s/r/1.33/customFieldValues?orderEid=<orderEid>
GET https://my.tractbilling.com/t/s/r/1.33/customFieldValues?orderNum=<orderNum>
GET https://my.tractbilling.com/t/s/r/1.33/customFieldValues?serviceEid=<serviceEid>
GET https://my.tractbilling.com/t/s/r/1.33/customFieldValues?orderItemEid=<orderItemEid>

Sample Requests and Responses

SOAP

Query and Response

In the following SOAP query of CustomFieldValue, the parameter of CustomFieldEid was used. The Custom Field's EID value (in this example "21") was learned through a previous query of CustomField.

<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>CustomFieldValue</type>
                    <parameter parameter="customFieldEid" parameterValue="21"/>>
                </simpleDataQuery>
            </ns2:queryRequest>
        </ns2:query>
    </soap:Body>
</soap:Envelope>

This was the response:

<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">
                <customFieldValues pageNumber="1" pageSize="50" totalElements="2" elementCount="2" totalPages="1">
                    <customFieldValue value="N" eid="4">
                        <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"/>
                    </customFieldValue>
                    <customFieldValue value="N" eid="5">
                        <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"/>
                    </customFieldValue>
                </customFieldValues>
            </ns2:return>
        </ns2:queryResponse>
    </soap:Body>
</soap:Envelope>

SOAP Example Query by Billing Account EID

In the following SOAP query of CustomFieldValue, the parameter of BillingAccountEid was used. The Billing Account's EID value (in this example "177312") was learned through a previous query of BillingAccount.

<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>CustomFieldValue</dom:type>
                    <dom:parameter parameter="billingAccountEid" parameterValue="177312" />
                </dom:simpleDataQuery>
            </ser:queryRequest>
        </ser:query>
    </soapenv:Body>
</soapenv:Envelope>

SOAP Example Query by Custom Field Name

In the following SOAP query of CustomFieldValue, the parameter of CustomFieldName of "Test Field 3" which was already known, was used.

<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>CustomFieldValue</dom:type>
                    <dom:parameter parameter="customFieldName" parameterValue="Test Field 3" />
                </dom:simpleDataQuery>
            </ser:queryRequest>
        </ser:query>
    </soapenv:Body>
</soapenv:Envelope>

SOAP Example Query by External Account Number

In the following SOAP query of CustomFieldValue, the parameter of ExternalAccountNumber of "33345" which was already known, was used.

<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>CustomFieldValue</dom:type>
                    <dom:parameter parameter="externalAccountNum" parameterValue="33345" />
                </dom:simpleDataQuery>
            </ser:queryRequest>
        </ser:query>
    </soapenv:Body>
</soapenv:Envelope>

SOAP Example Query by Billing Account Number

In the following SOAP query of CustomFieldValue, the parameter of (Billing) AccountNum of "113" which was already known, was used.

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

REST

REST Example Query and Response

In the following REST query of CustomFieldValue, the parameter of CustomFieldEid was used. The Custom Field's EID value (in this example "21") was learned through a previous query of CustomField:

GET https://my.tractbilling.com/t/s/r/1.33/customFieldValue?customFieldEid=21

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<customFieldValues xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain" pageNumber="1" pageSize="50" totalElements="2" elementCount="2" totalPages="1">
    <ns2:customFieldValue value="N" eid="4">
        <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"/>
    </ns2:customFieldValue>
    <ns2:customFieldValue value="N" eid="5">
        <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"/>
    </ns2:customFieldValue>
</customFieldValues>

Update a Custom Field Value

PUT https://my.tractbilling.com/t/s/r/1.33/customFieldValues/<custom field value eid>

<customFieldValue xmlns="http://www.tractbilling.com/billing/1_31/domain" value="99C2E813A58DF3E012A406A5D0C5D9580FDB1DC2BD8EBE3A54810014" eid="1593637"/>