PartyCategory

Version: 1.33

PartyCategory represents the Contact Category found at Setup >> Categories >> Contact Category. You can only query PartyCategory through the API. The most frequent use case for querying PartyCategory is to identify a category to use when creating a contact on an account.

Parameters

Extends: TractObject

Attributes

Attribute	Required?	Datatype	Description
name	Y	string	Name of the party category. Examples: "Sales Contact" "Primary Contact" "Proprietor".
description		string	Description of the party category.
status		PartyCategoryStatus	ACTIVE CANCELED SUSPENDED

Querying PartyCategory

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
name	String
description	String
status	ContactCategoryStatus

REST Endpoints

/partyCategories

getContactCategories	GET	https://my.tractbilling.com/t/s/r/1.33/partyCategories
getContactCategory	GET	https://my.tractbilling.com/t/s/r/1.33/partyCategories/{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>PartyCategory</type>
                </simpleDataQuery>
            </ns2:queryRequest>
        </ns2:query>
    </soap:Body>
</soap:Envelope>

REST

Query

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

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