Person

Version: 1.33

Person is an individual contact on a billing account. Most often, a person is created in the process of creating a billing account.

Parameters

Extends: Party

Elements

Element	Type	Required?	Description
category	PartyCategory	Y	The contact category for this person.

Attributes

Attribute	Required?	Datatype	Description
firstName	Y	string	Person's first name.
lastName	Y	string	Person's last name.
middleName		string	Person's middle name.
suffix		string	Suffix, if applicable.
dob		date	Person's date of birth.
company		string	Person's company or employer, if applicable.
department		string	Person's department, if applicable.
title		string	Person's title, if applicable.

Querying Person

[ For paged results, use the plural of the entity name (for example, billingAccounts, productCategories). For more information, refer to Understanding Queries.

Query Keys

Key	Type
eid	Long
firstName	String
lastName	String
billingAccountEid	Long

REST Endpoints

/people

getPeople	GET	https://my.tractbilling.com/t/s/r/1.33/people
addAddress	POST	https://my.tractbilling.com/t/s/r/1.33/people/{eid: \d+}/addAddress
updatePerson	PUT	https://my.tractbilling.com/t/s/r/1.33/people/{eid: \d+}
getPerson	GET	https://my.tractbilling.com/t/s/r/1.33/people/{eid: \d+}

Sample Requests and Responses

SOAP

Query

<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>Person</type>
                </simpleDataQuery>
            </ns2:queryRequest>
        </ns2:query>
    </soap:Body>
</soap:Envelope> 

REST

Query

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

GET https://my.tractbilling.com/t/s/r/1.33/people/<eid>

Add Address to Person

POST https://my.tractbilling.com/t/s/r/1.33/people/33345/addAddress

<addAddressToParty xmlns="http://www.tractbilling.com/billing/1_31/domain">
    <person eid="33345"/>
    <postalAddress purpose="BILLING" country="USA" 
city="Austin" regionOrState="TX" postalCode="77777" line1="1000 Guitar Way"/>
</addAddressToParty>

Update Person

PUT https://my.tractbilling.com/t/s/r/1.33/people/243812

<person eid="243812" name="Jonathon Smith" taxIdNumber="00-0000000" 
xmlns="http://www.tractbilling.com/billing/1_31/domain"/>

Querying Person

[ For paged results, use the plural of the entity name (for example, billingAccounts, productCategories). For more information, refer to Understanding Queries.

Query Keys

Key	Type
eid	Long
firstName	String
lastName	String
billingAccountEid	Long

REST Endpoints

/people

getPeople	GET	https://my.tractbilling.com/t/s/r/1.33/people
addAddress	POST	https://my.tractbilling.com/t/s/r/1.33/people/{eid: \d+}/addAddress
updatePerson	PUT	https://my.tractbilling.com/t/s/r/1.33/people/{eid: \d+}
getPerson	GET	https://my.tractbilling.com/t/s/r/1.33/people/{eid: \d+}

Sample Requests and Responses

SOAP

Query

<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>Person</type>
                </simpleDataQuery>
            </ns2:queryRequest>
        </ns2:query>
    </soap:Body>
</soap:Envelope> 

REST

Query

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

GET https://my.tractbilling.com/t/s/r/1.33/people/<eid>

Add Address to Person

POST https://my.tractbilling.com/t/s/r/1.33/people/33345/addAddress

<addAddressToParty xmlns="http://www.tractbilling.com/billing/1_31/domain">
    <person eid="33345"/>
    <postalAddress purpose="BILLING" country="USA" 
city="Austin" regionOrState="TX" postalCode="77777" line1="1000 Guitar Way"/>
</addAddressToParty>

Update Person

PUT https://my.tractbilling.com/t/s/r/1.33/people/243812

<person eid="243812" name="Jonathon Smith" taxIdNumber="00-0000000" 
xmlns="http://www.tractbilling.com/billing/1_31/domain"/>