Getting Started with REST

Before You Begin

See the API Overview.

Learn about Queries.

Resources and Endpoints

Accessible resources in Gotransverse are called Entities. Every entity has at least one REST endpoint, like BillingAccount

https://my.tractbilling.com/t/s/r/1.28/billingAccounts

Some endpoints are commands shared among entities, like ApplyPayment:

POST https://my.tractbilling.com/t/s/r/1.28/invoices/<eid>/applyPayment

POST https://my.tractbilling.com/t/s/r/1.28/billingAccounts/<eid>/applyPayment

Finding Help

List of REST endpoints and the calls they support - Supported Actions by Entity

List of REST endpoint by package - REST Endpoints

Help with specific entities - Locate the entity you need to interact with in the packages list or in the table of contents to see parameters for the entity and example calls. An example:

Making Calls

All REST calls on the Gotransverse API are made to the same root URL:

Root for REST requests https://my.tractbilling.com/t/s/r/1.28/
REST WADL https://my.tractbilling.com/t/s/r/1.28?_wadl

Header

You don't pass any information on your tenant in the call or the header; Gotransverse routes your call to the appropriate tenant based on your Gotransverse credentials. This means the basic header contains only your authorization credentials.

Requests with a body also need a content-type header to specify the body format. All request bodies must be formatted in application/xml.

Example header (HTTP)

Authorization: Basic aWFsZXhhbmRlci1RQTpmdWs4MzgzODMh
Content-Type: application/xml

Body

Request bodies must be formatted in application XML. Example body of a request to update the billType of a billing account: 

<billingAccount eid="277443" billType="PAPER" automaticRecurringPayment="true" xmlns="http://www.tractbilling.com/billing/1_28/domain">
                <billingAccountCategory eid="749"/>
</billingAccount>

Methods

The Gotransverse API supports three types of REST method:

GET query for objects, collections of objects, or specific parameters within objects
POST create new instances of objects or perform actions like status changes on objects
PUT edit parameters within objects

Where to Go Next

REST GET Tutorial

REST POST and PUT Tutorial

Datatypes


Top