ServicePeriod

Version: 1.33

ServicePeriod is the time period for which charges for a service occur and are then billed to a Billing Account. ServicePeriod is used to determine to which billing period a usage event belongs. ServicePeriod can be queried directly and also queried and used through Service.

Parameters

Each ServicePeriod 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.

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 all entities in Gotransverse.
service	Y	Service	- -	The Service used during this Service Period.
usageRules		UsageRules	- -	The Usage Rules associated with the Service in the Service Period.
usageEvents		UsageEvents	- -	The Usage Events associated with the Service in the Service Period.
start	Y	DateTime	Refer to Data Types for dateTime formats.	Date on which the Service Period for the Service started.
end	Y	DateTime	Refer to Data Types for dateTime formats.	Date on which the Service Period for the Service ended.
closed	Y	Boolean	Shown either: "true" (Yes) or "false" (No)	Is this Service Period closed? YES, this Service Period is closed. NO, this Service Period is NOT closed (it is open).

Entity ServicePeriods

The entity ServicePeriods enables you to see multiple pages of the entity ServicePeriod.

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.
servicePeriods	ServicePeriod	- -	Shows the list of ServicePeriods.

Information for the related entity of ServicePeriods:

• Entity ServicePeriods

Query to See a Service Period

Query Key Information for SOAP and REST

Querying to see Service Periods needs to include one of the following parameters. If you do not know the value for the parameter, query separately to learn the value.

Query Key Parameters

ServicePeriod

Query Key	Value	Definition
eid	Long	The eid number of the Service Period.
serviceEid	Long	The eid number of the Service.
startDate	DateTime	The start date of the Service Period.
endDate	Daytime	The end date of the Service Period.
closed	Boolean	Whether or not the Service Period is closed.

Query to Use

Query to Use	Query for	Parameter Name and Value	Returns
SimpleDataQuery	ServicePeriod	<parameter name><parameter value>	List of your Service Periods for that parameter name and value

SOAP Example Query

In the following example SOAP query, the parameter of serviceEid was used. The Service's EID value (in this example "920"), was learned through a previous query on Service.

<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>ServicePeriod</type>
                    <parameter parameter="serviceEid" parameterValue="920"/>
                </simpleDataQuery>
            </ns2:queryRequest>
        </ns2:query>
    </soap:Body>
</soap:Envelope>

REST Mount Point and Parameters

Query

GET https://my.tractbilling.com/t/s/r/1.33/servicePeriods/<eid>
GET https://my.tractbilling.com/t/s/r/1.33/servicePeriods?eid=<eid>
GET https://my.tractbilling.com/t/s/r/1.33/servicePeriods?serviceEid=<serviceEid>
GET https://my.tractbilling.com/t/s/r/1.33/servicePeriods?startDate=<startDate>
GET https://my.tractbilling.com/t/s/r/1.33/servicePeriods?endDate=<endDate>
GET https://my.tractbilling.com/t/s/r/1.33/servicePeriods?closed=<closed>