BillingAccountSegment

Version: 1.33

Billing account segments are a way to segment your accounts and make various fields mandatory at order time. You can enable account segments in System Settings by activating the parameter Use Account Segment. You can only query billing account segments via the API; you must create segments and segment fields in GTV.

Parameters

Extends: TractObject

Elements

Element	Type	Required?	Description
billingAccountSegmentFields	billingAccountSegmentFields		The list of fields that can be used with this segment.

Attributes

Attribute	Required?	Datatype	Description
name	Y	string	The name of this segment.
description		string	The description of this segment.
status	Y	BillingAccountSegmentStatus	DRAFT ACTIVE DRAFT SUSPENDEDDRAFT

Querying BillingAccountSegment

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
status	customer.segment.BillingAccountSegmentStatus

REST Endpoints

/billingAccountSegments

getBillingAccountSegments	GET	https://my.tractbilling.com/t/s/r/1.33/billingAccountSegments
getBillingAccountSegment	GET	https://my.tractbilling.com/t/s/r/1.33/billingAccountSegments/{eid: \d+}