Agreement

Version: 1.33

An agreement in Gotransverse dictates the terms of service.

Parameters

Extends: TractObject

Elements
Element	Type	Required?	Description
adjustmentCategory	adjustmentCategory	Yes	The user-defined category for the adjustment attached to this agreement.
nextAgreement	Agreement		The next agreement to move the service to.
trueUpAdjustmentReason	AdjustmentReason		The user-defined reason for the true-up adjustment, if applicable.
trueUpChargeTypes	trueUpChargeTypes		The user-defined charge type for the true-up charge, if applicable.

Attributes
Attribute	Datatype	Description
name	string	The name of this agreement.
agreementPeriod	int	The number of months or days (defined by agreementPeriodType) this agreement covers.
status	AgreementStatus	DRAFT ACTIVE SUSPENDED
terminationFlatCharge	decimal	A flat charge to apply on termination, if applicable.
terminationPercentageCharge	decimal	A percentage charge to apply on termination, if applicable.
maxTerminationCharge	decimal	An amount limit for a termination charge.
prorateOnCancel	boolean	Prorate the termination fee on cancellation?
endAction	AgreementEndAction	RENEW_AGREEMENT SERVICE_ONLY DEACTIVATE_SERVICE CHANGE_AGREEMENT CHANGE_SERVICE
terminationFeeCurrencyType	CurrencyType	USD EUR CAD GBP MXN JPY NOK SEK DKK AUD INR NZD ZAR AED SAR QAR EGP OMR KWD BHD ILS CNY HKD CHF
maxTerminationFeeCurrencyType	CurrencyType	USD EUR CAD GBP MXN JPY NOK SEK DKK AUD INR NZD ZAR AED SAR QAR EGP OMR KWD BHD ILS CNY HKD CHF
fromDate	dateTime	The agreement start date.
thruDate	dateTime	The agreement end date.
agreementPeriodType	AgreementPeriodType	MONTH DAY
minimumAmount	decimal	The minimum change for the agreement, used for true up charges.
minimumAmountCurrencyType	CurrencyType	USD EUR CAD GBP MXN JPY NOK SEK DKK AUD INR NZD ZAR AED SAR QAR EGP OMR KWD BHD ILS CNY HKD CHF
preserveServicePrice	boolean	A flag to determine is the user selected default pricing selection during the creation of a new agreement.

Querying Agreement

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

Query Keys

Query Keys
Key	Type
eid	Long
name	String
productEid	Long
status	AgreementStatus
terminationFeeCurrencyType	java.util.Currency
maxTerminationFeeCurrencyType	java.util.Currency
fromDate	Timestamp
thruDate	Timestamp

REST Endpoints

/services
addAgreement	POST	https://my.tractbilling.com/t/s/r/1.33/services/{eid: \d+}/addAgreement

/agreements
getAgreements	GET	https://my.tractbilling.com/t/s/r/1.33/agreements
getAgreement	GET	https://my.tractbilling.com/t/s/r/1.33/agreements/{eid: \d+}

/agreementServices
getAgreementServices	GET	https://my.tractbilling.com/t/s/r/1.33/agreementServices
getAgreementService	GET	https://my.tractbilling.com/t/s/r/1.33/agreementServices/{eid: \d+}
agreementService	PUT	https://my.tractbilling.com/t/s/r/1.33/agreementServices/{eid: \d+}
addTrueUpChargeType	POST	https://my.tractbilling.com/t/s/r/1.33/agreementServices/{eid: \d+}/addTrueUpChargeType
removeTrueUpChargeType	POST	https://my.tractbilling.com/t/s/r/1.33/agreementServices/{eid: \d+}/removeTrueUpChargeType

Sample Requests and Responses

SOAP

Add Agreement To Service

<soapenv:Header/>
    <soapenv:Body>
        <ser:command>
            <ser:commandRequest>
                <dom:addAgreementToService>
                    <dom:service eid="2059070" />
                    <dom:agreementService endAction="RENEW_AGREEMENT" startDate="2014-07-06T00:00:00-06:00" preserveServicePrice="true">
                        <dom:agreement eid="10494" /> </dom:agreementService>
                </dom:addAgreementToService>
            </ser:commandRequest>
        </ser:command>
        <ser1:command xmlns:ser1="http://www.tractbilling.com/billing/1_31/service" />
   </soapenv:Body>

REST

Add Agreement to Service

POST https://my.tractbilling.com/t/s/r/1.33/services/2086894/addAgreement

<addAgreementToService xmlns="http://www.tractbilling.com/billing/1_33/domain" startDate="2017-08-03T06:00:00-05:00">
	<service eid="2086894"/>
	<agreement eid="2940"/>
	<agreementConfiguration endDate="2017-08-21T06:00:00-05:00"/>
</addAgreementToService>

Refer to the following topics for more information: