BillingAccount
Version: 1.33
Parameters
Extends: TractObject
| Element | Type | Required? | Description |
|
CHOICE:
|
dailyBillCycle monthlyBillCycle quarterlyBillCycle yearlyBillCycle segmentedMonthlyBillCycle |
Y |
The bill cycle this account is attached to. |
CHOICE:
|
person organization |
Y |
The responsible party for this account. When creating an account, can be an existing person or organization EID or a new person/organization. |
|
CHOICE:
|
deactivationReason suspensionReason |
Y |
The deactivation or suspension reason, if applicable. |
|
recurringPayments |
recurringPayments |
|
A list of recurring payments for this account. |
|
billingAccountCategory |
billingAccountCategory |
|
The category this account belongs to. |
|
services |
services |
|
A list of all services attached to this account. |
|
pendingCharges |
OrderItemCharges |
|
A list of any pending charges. |
|
customFieldValues |
customFieldValues |
|
A list of any custom field values associated with this account. |
|
people |
people |
|
Additional contacts for this account. |
|
paymentTerm |
paymentTerm |
|
The payment term for this account. |
|
billingAccountSegment |
billingAccountSegment |
|
The billing account segment this account is part of. |
|
parentBillingAccount |
BillingAccount |
|
The parent of this account, if applicable. |
responsibleAccount | BillingAccount |
| The account that will be billed/invoiced on this account's behalf. |
| Attribute | Required? | Datatype | Description |
|
accountNum |
|
string |
The account number. |
|
externalAccountNum |
|
string |
An external account number, if applicable. |
|
billType |
|
BillType |
|
|
automaticRecurringPayment |
|
boolean |
Is auto-pay enabled for this account? |
|
status |
|
BillingAccountStatus |
|
|
pendingChargesTotal |
|
decimal |
Total of all pending charges on the account. |
|
balance |
|
decimal |
Total outstanding balance on the account. |
|
startDate |
|
dateTime |
Date the account was created. |
|
endDate |
|
dateTime |
Date the account was deactivated. |
|
taxExempt |
|
boolean |
Is this account tax-exempt? |
|
currencyType |
|
CurrencyType |
|
|
nextInvoiceDate |
|
dateTime |
The next invoice date for this account. |
Querying BillingAccount
For paged results, use the plural of the entity name (for example, billingAccounts, productCategories). For more information, refer to Understanding Queries.
| Key | Type |
|
eid |
Long |
|
accountNum |
String |
|
externalAccountNum |
String |
|
partyEid |
Long |
|
status |
BillingAccountStatus |
|
emailAddress |
String |
|
billingAccountCategoryEid |
Long |
|
purchaseOrderNumber |
Sting |
|
orderNum |
String |
|
orderEid |
Long |
|
billType |
BillType |
|
referral |
String |
|
customFieldValueEid |
Long |
|
billingAccountSegmentEid |
Long |
|
currencyType |
CurrencyType |
|
productEid |
Long |
|
serviceEid |
Long |
|
parentEid |
Long |
|
billycleEid |
Long |
|
customFieldValue |
String |
|
customFieldEid |
Log |
|
serviceCustomFieldValue |
String |
|
serviceCustomFieldEid |
Long |
|
orderCustomFieldValue |
String |
|
orderCustomFieldEid |
Long |
|
usagePoolEid |
Long |
|
responsibleAccountEid |
Long |
REST Endpoints
|
getBillingAccounts |
GET |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts |
|
createBillingAccount |
POST |
https://my.trctbilling.com/t/s/r/1.33/billingAccounts |
|
voidDraftOrder |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/voidDraftOrder |
|
createDraftOrder |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/createDraftOrder |
|
applyPayment |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/applyPayment |
|
addUsagePoolToBillingAccount |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/addUsagePool |
|
addNoteToBillingAccount |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/addNote |
|
addParentBillingAccount |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/addParentBillingAccount |
|
removeParentBillingAccount |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/removeParentBillingAccount |
|
changeParentBillingAccount |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/changeParentBillingAccount |
|
changeService |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/changeService |
|
getBillingAccount |
GET |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid} |
|
updateBillingAccount |
PUT |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid} |
|
addCustomFieldValue |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/addCustomFieldValue |
|
removeCustomFieldValue |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/removeCustomFieldValue |
|
reactivateAccountStatus |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/resume |
|
addRecurringPayment |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/addRecurringPayment |
|
addPerson |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/addPerson |
|
suspendAccountStatus |
PST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/suspend |
|
deactivateAccountStatus |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/deactivate |
|
removePerson |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/removePerson |
|
moveToBillCycle |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/moveToBillCycle |
|
billOnDemand |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/billOnDemand |
|
addAdjustment |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/addAdjustment |
|
addResponsibleAccount |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/addResponsibleAccount |
|
removeResponsibleAccount |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/removeResponsibleAccount |
|
changeResponsibleAccount |
POST |
https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/changeResponsibleAccount |
|
getBillingAccountCategorys |
GET |
https://my.tractbilling.com/t/s/r/1.33/billingAccountCategories |
|
getBillingAccountCategory |
GET |
https://my.tractbilling.com/t/s/r/1.33/billingAccountCategories/{eid} |
|
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} |
|
getBillingAccountSegmentFields |
GET |
https://my.tractbilling.com/t/s/r/1.33/billingAccountSegmentFields |
|
getBillingAccountSegmentField |
GET |
https://my.tractbilling.com/t/s/r/1.33/billingAccountSegmentFields/{eid} |
Sample Requests and Responses
SOAP
Example Query and Response
SOAP Example Query and Response
The following SOAP example is a query of BillingAccount:
<?xml version="1.0" ?>
<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 size="50" startIndex="0">
<type>BillingAccount</type>
</simpleDataQuery>
</ns2:queryRequest>
</ns2:query>
</soap:Body>
</soap:Envelope>
This was the response:
<?xml version="1.0" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:queryResponse xmlns="http://www.tractbilling.com/billing/1_31/domain" xmlns:ns2="http://www.tractbilling.com/billing/1_31/service">
<ns2:return successful="true">
<billingAccounts elementCount="2" pageNumber="1" pageSize="50" totalElements="2" totalPages="1">
<billingAccount accountNum="100003090" automaticRecurringPayment="false" balance="54.82" billType="PAPER" eid="48" pendingChargesTotal="0.00" status="ACTIVE">
<monthlyBillCycle autoBill="false" billCycleType="Monthly" dayOfMonth="1" eid="35" endDate="2012-11-01T00:00:00-05:00" name="Bill Cycle 1" startDate="2012-10-01T00:00:00-05:00"/>
<person dob="1965-06-04" eid="49" firstName="JACK" lastName="SMITH" taxIdNumber="***-**-0000">
<addresses>
<postalAddress city="ATLANTA" country="USA" eid="131" line1="604 1965TH AVENUE" postalCode="19650" purpose="SERVICE" regionOrState="GA"/>
<postalAddress city="ATLANTA" country="USA" eid="132" line1="604 1965TH AVENUE" postalCode="19650" purpose="BILLING" regionOrState="GA"/>
<postalAddress city="ATLANTA" country="USA" eid="133" line1="604 1965TH AVENUE" postalCode="19650" purpose="SHIPPING" regionOrState="GA"/>
</addresses>
</person>
<billingAccountCategory description="Default billing account category" eid="10" status="BA_CATEGORY_ACTIVE" type="All Accounts"/>
<services elementCount="0" pageNumber="1" pageSize="50" totalElements="2" totalPages="1"/>
</billingAccount>
<billingAccount accountNum="100003128" automaticRecurringPayment="false" balance="174.90" billType="PAPER" eid="49" pendingChargesTotal="0.00" status="ACTIVE">
<monthlyBillCycle autoBill="false" billCycleType="Monthly" dayOfMonth="1" eid="35" endDate="2012-11-01T00:00:00-05:00" name="Bill Cycle 1" startDate="2012-10-01T00:00:00-05:00"/>
<person dob="1966-06-06" eid="50" firstName="DAN" lastName="SMITH" taxIdNumber="***-**-0000">
<addresses>
<postalAddress city="NINETEEN" country="USA" eid="134" line1="606 66TH STREET" postalCode="60619" purpose="SERVICE" regionOrState="MS"/>
<postalAddress city="NINETEEN" country="USA" eid="135" line1="606 66TH STREET" postalCode="60619" purpose="BILLING" regionOrState="MS"/>
<postalAddress city="NINETEEN" country="USA" eid="136" line1="606 66TH STREET" postalCode="60619" purpose="SHIPPING" regionOrState="MS"/>
</addresses>
</person>
<billingAccountCategory description="Default billing account category" eid="10" status="BA_CATEGORY_ACTIVE" type="All Accounts"/>
<services elementCount="0" pageNumber="1" pageSize="50" totalElements="4" totalPages="1"/>
</billingAccount>
</billingAccounts>
</ns2:return>
</ns2:queryResponse>
</soap:Body>
</soap:Envelope>
Add a Responsible Account
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:command xmlns="http://www.tractbilling.com/billing/1_31/domain" xmlns:ns2="http://www.tractbilling.com/billing/1_31/service" xmlns:ns3="http://www.tractbilling.com/billing/1_31/domain/rest">
<ns2:commandRequest>
<addResponsibleAccount>
<billingAccount accountNum="362" billType="EMAIL" automaticRecurringPayment="false" status="ACTIVE" pendingChargesTotal="50.00" balance="0.00" startDate="2016-03-15T13:03:42.000-05:00" taxExempt="false" currencyType="USD" nextInvoiceDate="2015-04-12T00:00:00.000-05:00" eid="369" queryScope="SHALLOW">
<dailyBillCycle eid="6" queryScope="EID"/>
<person eid="377" queryScope="EID"/>
<billingAccountCategory eid="4" queryScope="EID"/>
<services pageNumber="1" pageSize="50" totalElements="1" elementCount="0" totalPages="1"/>
<pendingCharges pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
<customFieldValues pageNumber="1" pageSize="50" totalElements="0" elementCount="0" totalPages="0"/>
<paymentTerm termDays="0" graceDays="0" eid="6" queryScope="EID"/>
<responsibleAccount eid="369" queryScope="EID"/>
</billingAccount>
<responsibleAccount accountNum="363" billType="EMAIL" automaticRecurringPayment="false" status="ACTIVE" pendingChargesTotal="50.00" balance="0.00" startDate="2016-03-15T13:03:44.000-05:00" taxExempt="false" currencyType="USD" nextInvoiceDate="2015-04-12T00:00:00.000-05:00" eid="370" queryScope="SHALLOW">
<dailyBillCycle eid="6" queryScope="EID"/>
<person eid="378" queryScope="EID"/>
<billingAccountCategory eid="4" queryScope="EID"/>
<services pageNumber="1" pageSize="50" totalElements="1" elementCount="0" totalPages="1"/>
<pendingCharges pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
<customFieldValues pageNumber="1" pageSize="50" totalElements="0" elementCount="0" totalPages="0"/>
<paymentTerm termDays="0" graceDays="0" eid="6" queryScope="EID"/>
<responsibleAccount eid="370" queryScope="EID"/>
</responsibleAccount>
</addResponsibleAccount>
</ns2:commandRequest>
</ns2:command>
</soap:Body>
</soap:Envelope>
Change a Responsible Account
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:command xmlns="http://www.tractbilling.com/billing/1_31/domain" xmlns:ns2="http://www.tractbilling.com/billing/1_31/service" xmlns:ns3="http://www.tractbilling.com/billing/1_31/domain/rest">
<ns2:commandRequest>
<changeResponsibleAccount>
<billingAccount accountNum="362" billType="EMAIL" automaticRecurringPayment="false" status="ACTIVE" pendingChargesTotal="50.00" balance="0.00" startDate="2016-03-15T13:03:42.000-05:00" taxExempt="false" currencyType="USD" nextInvoiceDate="2015-04-12T00:00:00.000-05:00" eid="369" queryScope="SHALLOW">
<dailyBillCycle eid="6" queryScope="EID"/>
<person eid="377" queryScope="EID"/>
<billingAccountCategory eid="4" queryScope="EID"/>
<services pageNumber="1" pageSize="50" totalElements="1" elementCount="0" totalPages="1"/>
<pendingCharges pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
<customFieldValues pageNumber="1" pageSize="50" totalElements="0" elementCount="0" totalPages="0"/>
<paymentTerm termDays="0" graceDays="0" eid="6" queryScope="EID"/>
<responsibleAccount eid="369" queryScope="EID"/>
</billingAccount>
<responsibleAccount accountNum="364" billType="EMAIL" automaticRecurringPayment="false" status="ACTIVE" pendingChargesTotal="50.00" balance="0.00" startDate="2016-03-15T13:03:46.000-05:00" taxExempt="false" currencyType="USD" nextInvoiceDate="2015-04-12T00:00:00.000-05:00" eid="371" queryScope="SHALLOW">
<dailyBillCycle eid="6" queryScope="EID"/>
<person eid="379" queryScope="EID"/>
<billingAccountCategory eid="4" queryScope="EID"/>
<services pageNumber="1" pageSize="50" totalElements="1" elementCount="0" totalPages="1"/>
<pendingCharges pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
<customFieldValues pageNumber="1" pageSize="50" totalElements="0" elementCount="0" totalPages="0"/>
<paymentTerm termDays="0" graceDays="0" eid="6" queryScope="EID"/>
<responsibleAccount eid="371" queryScope="EID"/>
</responsibleAccount>
</changeResponsibleAccount>
</ns2:commandRequest>
</ns2:command>
</soap:Body>
</soap:Envelope>
Remove a Responsible Account
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:command xmlns="http://www.tractbilling.com/billing/1_31/domain" xmlns:ns2="http://www.tractbilling.com/billing/1_31/service" xmlns:ns3="http://www.tractbilling.com/billing/1_31/domain/rest">
<ns2:commandRequest>
<removeResponsibleAccount>
<billingAccount accountNum="362" billType="EMAIL" automaticRecurringPayment="false" status="ACTIVE" pendingChargesTotal="50.00" balance="0.00" startDate="2016-03-15T13:03:42.000-05:00" taxExempt="false" currencyType="USD" nextInvoiceDate="2015-04-12T00:00:00.000-05:00" eid="369" queryScope="SHALLOW">
<dailyBillCycle eid="6" queryScope="EID"/>
<person eid="377" queryScope="EID"/>
<billingAccountCategory eid="4" queryScope="EID"/>
<services pageNumber="1" pageSize="50" totalElements="1" elementCount="0" totalPages="1"/>
<pendingCharges pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
<customFieldValues pageNumber="1" pageSize="50" totalElements="0" elementCount="0" totalPages="0"/>
<paymentTerm termDays="0" graceDays="0" eid="6" queryScope="EID"/>
<responsibleAccount eid="369" queryScope="EID"/>
</billingAccount>
<responsibleAccount accountNum="364" billType="EMAIL" automaticRecurringPayment="false" status="ACTIVE" pendingChargesTotal="50.00" balance="0.00" startDate="2016-03-15T13:03:46.000-05:00" taxExempt="false" currencyType="USD" nextInvoiceDate="2015-04-12T00:00:00.000-05:00" eid="371" queryScope="SHALLOW">
<dailyBillCycle eid="6" queryScope="EID"/>
<person eid="379" queryScope="EID"/>
<billingAccountCategory eid="4" queryScope="EID"/>
<services pageNumber="1" pageSize="50" totalElements="1" elementCount="0" totalPages="1"/>
<pendingCharges pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
<customFieldValues pageNumber="1" pageSize="50" totalElements="0" elementCount="0" totalPages="0"/>
<paymentTerm termDays="0" graceDays="0" eid="6" queryScope="EID"/>
<responsibleAccount eid="371" queryScope="EID"/>
</responsibleAccount>
</removeResponsibleAccount>
</ns2:commandRequest>
</ns2:command>
</soap:Body>
</soap:Envelope>
REST
REST Example Query and Response
The following example is the REST query with no parameters defined:
GET https://my.tractbilling.com/t/s/r/1.33/billingAccounts
This was the response (line breaks and formatting added for ease of reading):
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<billingAccounts xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain" pageNumber="1" pageSize="50" totalElements="8" elementCount="8" totalPages="1">
<ns2:billingAccount accountNum="1" billType="EMAIL" automaticRecurringPayment="false" status="ACTIVE" pendingChargesTotal="5.00" balance="0.00" eid="19623">
<ns2:monthlyBillCycle dayOfMonth="1" name="Bill Cycle 1" startDate="2013-01-01T00:00:00-06:00"
endDate="2013-02-01T00:00:00-06:00" billCycleType="Monthly" autoBill="false" eid="2289"/>
<ns2:organization name="Smith Cookie Factory" taxIdNumber="00-0000000" eid="19609">
<ns2:addresses>
<ns2:postalAddress purpose="BILLING" country="USA" city="Dough" regionOrState="MT"
postalCode="55577" line1="123 Factory Road" eid="94454"/>
<ns2:postalAddress purpose="SERVICE" country="USA" city="Dough" regionOrState="MT"
postalCode="55577" line1="123 Factory Road" eid="94455"/>
<ns2:postalAddress purpose="SHIPPING" country="USA" city="Dough" regionOrState="MT"
postalCode="55577" line1="123 Factory Road" eid="94456"/>
<ns2:emailAddress purpose="PRIMARY" email="smith@smithcookiefactory.com" eid="94457"/>
</ns2:addresses>
</ns2:organization>
<ns2:billingAccountCategory type="All Accounts" description="Default billing account category"
status="BA_CATEGORY_ACTIVE" eid="244"/>
<ns2:services pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
<ns2:pendingCharges pageNumber="1" pageSize="50" totalElements="3" elementCount="0" totalPages="1"/>
</ns2:billingAccount>
<ns2:billingAccount accountNum="2" billType="EMAIL" automaticRecurringPayment="false" status="ACTIVE" pendingChargesTotal="0.00" balance="0.00" eid="19663">
<ns2:monthlyBillCycle dayOfMonth="1" name="Bill Cycle 1" startDate="2013-01-01T00:00:00-06:00"
endDate="2013-02-01T00:00:00-06:00" billCycleType="Monthly" autoBill="false" eid="2289"/>
<ns2:organization name="Smith Cake Factory" taxIdNumber="00-0000000" eid="19650">
<ns2:addresses>
<ns2:postalAddress purpose="SERVICE" country="USA" city="Flour" regionOrState="MT"
postalCode="55555" line1="100 Factory Road" eid="94637"/>
<ns2:postalAddress purpose="BILLING" country="USA" city="Flour" regionOrState="MT"
postalCode="55555" line1="100 Factory Road" eid="94638"/>
<ns2:postalAddress purpose="SHIPPING" country="USA" city="Flour" regionOrState="MT"
postalCode="55555" line1="100 Factory Road" eid="94639"/>
<ns2:emailAddress purpose="PRIMARY" email="smith@smithcakefactory.com" eid="94640"/>
</ns2:addresses>
</ns2:organization>
<ns2:billingAccountCategory type="All Accounts" description="Default billing account category"
status="BA_CATEGORY_ACTIVE" eid="244"/>
<ns2:services pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
<ns2:pendingCharges pageNumber="1" pageSize="50" totalElements="3" elementCount="0" totalPages="1"/>
</ns2:billingAccount>
<ns2:billingAccount accountNum="3" billType="PAPER" automaticRecurringPayment="false" status="ACTIVE" pendingChargesTotal="0.00" balance="0.00" eid="19757">
<ns2:monthlyBillCycle dayOfMonth="1" name="Bill Cycle 1" startDate="2013-01-01T00:00:00-06:00"
endDate="2013-02-01T00:00:00-06:00" billCycleType="Monthly" autoBill="false" eid="2289"/>
<ns2:person firstName="Sam" lastName="Smith" eid="19754">
<ns2:addresses>
<ns2:postalAddress purpose="SERVICE" country="USA" city="Smith" regionOrState="AL"
postalCode="33333" line1="123 Sam Way" eid="95068"/>
<ns2:postalAddress purpose="BILLING" country="USA" city="Smith" regionOrState="AL"
postalCode="33333" line1="123 Sam Way" eid="95069"/>
<ns2:postalAddress purpose="SHIPPING" country="USA" city="Smith" regionOrState="AL"
postalCode="33333" line1="123 Sam Way" eid="95070"/>
</ns2:addresses>
</ns2:person>
<ns2:billingAccountCategory type="All Accounts" description="Default billing account category"
status="BA_CATEGORY_ACTIVE" eid="244"/>
<ns2:services pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
<ns2:pendingCharges pageNumber="1" pageSize="50" totalElements="3" elementCount="0" totalPages="1"/>
</ns2:billingAccount>
<ns2:billingAccount accountNum="4" billType="EMAIL" automaticRecurringPayment="false" status="ACTIVE" pendingChargesTotal="0.00" balance="0.00" eid="19895">
<ns2:monthlyBillCycle dayOfMonth="1" name="Bill Cycle 1" startDate="2013-01-01T00:00:00-06:00"
endDate="2013-02-01T00:00:00-06:00" billCycleType="Monthly" autoBill="false" eid="2289"/>
<ns2:organization name="Smith Senior Residence #1" eid="19894">
<ns2:addresses>
<ns2:postalAddress purpose="SERVICE" country="USA" city="Sunset" regionOrState="MT"
postalCode="55555" line1="123 Retirement Way" eid="95673"/>
<ns2:postalAddress purpose="BILLING" country="USA" city="Sunset" regionOrState="MT"
postalCode="55555" line1="123 Retirement Way" eid="95674"/>
<ns2:postalAddress purpose="SHIPPING" country="USA" city="Sunset" regionOrState="MT"
postalCode="55555" line1="123 Retirement Way" eid="95675"/>
<ns2:emailAddress purpose="PRIMARY" email="manager@smithseniorresidence1.com" eid="95676"/>
</ns2:addresses>
</ns2:organization>
<ns2:billingAccountCategory type="All Accounts" description="Default billing account category"
status="BA_CATEGORY_ACTIVE" eid="244"/>
<ns2:services pageNumber="1" pageSize="50" totalElements="1" elementCount="0" totalPages="1"/>
<ns2:pendingCharges pageNumber="1" pageSize="50" totalElements="1" elementCount="0" totalPages="1"/>
</ns2:billingAccount>
<ns2:billingAccount accountNum="5" billType="EMAIL" automaticRecurringPayment="false" status="ACTIVE" pendingChargesTotal="5.00" balance="-15.00" eid="19972">
<ns2:monthlyBillCycle dayOfMonth="1" name="Bill Cycle 1" startDate="2013-01-01T00:00:00-06:00"
endDate="2013-02-01T00:00:00-06:00" billCycleType="Monthly" autoBill="false" eid="2289"/>
<ns2:person firstName="Jimmy" lastName="Smith" eid="19977">
<ns2:addresses>
<ns2:postalAddress purpose="SERVICE" country="USA" city="Smithopolis" regionOrState="OH"
postalCode="66666" line1="123 Here Street" eid="96030"/>
<ns2:postalAddress purpose="BILLING" country="USA" city="Smithopolis" regionOrState="OH"
postalCode="66666" line1="123 Here Street" eid="96031"/>
<ns2:postalAddress purpose="SHIPPING" country="USA" city="Smithopolis" regionOrState="OH"
postalCode="66666" line1="123 Here Street" eid="96032"/>
<ns2:emailAddress purpose="PRIMARY" email="jsmith@gotransverse.com" eid="96033"/>
</ns2:addresses>
</ns2:person>
<ns2:billingAccountCategory type="All Accounts" description="Default billing account category"
status="BA_CATEGORY_ACTIVE" eid="244"/>
<ns2:services pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
<ns2:pendingCharges pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
</ns2:billingAccount>
<ns2:billingAccount accountNum="6" billType="EMAIL" automaticRecurringPayment="false" status="ACTIVE" pendingChargesTotal="5.00" balance="0.00" eid="19973">
<ns2:monthlyBillCycle dayOfMonth="1" name="Bill Cycle 1" startDate="2013-01-01T00:00:00-06:00"
endDate="2013-02-01T00:00:00-06:00" billCycleType="Monthly" autoBill="false" eid="2289"/>
<ns2:person firstName="Dan" lastName="Smith" eid="19979">
<ns2:addresses>
<ns2:postalAddress purpose="SERVICE" country="USA" city="Smithopolis" regionOrState="MO"
postalCode="67676" line1="555 There Street" eid="96039"/>
<ns2:postalAddress purpose="BILLING" country="USA" city="Smithopolis" regionOrState="MO"
postalCode="67676" line1="555 There Street" eid="96040"/>
<ns2:postalAddress purpose="SHIPPING" country="USA" city="Smithopolis" regionOrState="MO"
postalCode="67676" line1="555 There Street" eid="96041"/>
<ns2:emailAddress purpose="PRIMARY" email="dsmith@gotransverse.com" eid="96042"/>
</ns2:addresses>
</ns2:person>
<ns2:billingAccountCategory type="All Accounts" description="Default billing account category"
status="BA_CATEGORY_ACTIVE" eid="244"/>
<ns2:services pageNumber="1" pageSize="50" totalElements="1" elementCount="0" totalPages="1"/>
<ns2:pendingCharges pageNumber="1" pageSize="50" totalElements="1" elementCount="0" totalPages="1"/>
</ns2:billingAccount>
<ns2:billingAccount accountNum="7" billType="EMAIL" automaticRecurringPayment="false" status="ACTIVE" pendingChargesTotal="10.00" balance="0.00" eid="19974">
<ns2:monthlyBillCycle dayOfMonth="1" name="Bill Cycle 1" startDate="2013-01-01T00:00:00-06:00"
endDate="2013-02-01T00:00:00-06:00" billCycleType="Monthly" autoBill="false" eid="2289"/>
<ns2:person firstName="Janet" lastName="Smith" eid="19980">
<ns2:addresses>
<ns2:postalAddress purpose="SERVICE" country="USA" city="Smith" regionOrState="NV"
postalCode="88888" line1="111 Smith Street" eid="96043"/>
<ns2:postalAddress purpose="BILLING" country="USA" city="Smith" regionOrState="NV"
postalCode="88888" line1="111 Smith Street" eid="96044"/>
<ns2:postalAddress purpose="SHIPPING" country="USA" city="Smith" regionOrState="NV"
postalCode="88888" line1="111 Smith Street" eid="96045"/>
<ns2:emailAddress purpose="PRIMARY" email="jansmith@gotransverse.com" eid="96046"/>
</ns2:addresses>
</ns2:person>
<ns2:billingAccountCategory type="All Accounts" description="Default billing account category"
status="BA_CATEGORY_ACTIVE" eid="244"/>
<ns2:services pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
<ns2:pendingCharges pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
</ns2:billingAccount>
<ns2:billingAccount accountNum="8" billType="EMAIL" automaticRecurringPayment="false" status="ACTIVE" pendingChargesTotal="20.00" balance="0.00" eid="19975">
<ns2:monthlyBillCycle dayOfMonth="1" name="Bill Cycle 1" startDate="2013-01-01T00:00:00-06:00"
endDate="2013-02-01T00:00:00-06:00" billCycleType="Monthly" autoBill="false" eid="2289"/>
<ns2:person firstName="John" lastName="Smith" eid="19981">
<ns2:addresses>
<ns2:postalAddress purpose="SERVICE" country="USA" city="Smith" regionOrState="NV"
postalCode="88888" line1="111 Smith Street" eid="96047"/>
<ns2:postalAddress purpose="BILLING" country="USA" city="Smith" regionOrState="NV"
postalCode="88888" line1="111 Smith Street" eid="96048"/>
<ns2:postalAddress purpose="SHIPPING" country="USA" city="Smith" regionOrState="NV"
postalCode="88888" line1="111 Smith Street" eid="96049"/>
<ns2:emailAddress purpose="PRIMARY" email="johnsmith@gotransverse.com" eid="96050"/>
</ns2:addresses>
</ns2:person>
<ns2:billingAccountCategory type="All Accounts" description="Default billing account category"
status="BA_CATEGORY_ACTIVE" eid="244"/>
<ns2:services pageNumber="1" pageSize="50" totalElements="4" elementCount="0" totalPages="1"/>
<ns2:pendingCharges pageNumber="1" pageSize="50" totalElements="4" elementCount="0" totalPages="1"/>
</ns2:billingAccount>
</billingAccounts>
Apply a Payment to a Specific Invoice on a Billing Account
See ApplyPayment for more details and more examples. In the following example, the Billing Account EID value of "240680" and the Invoice EID value of "602814" were learned through separate Queries.
POST https://my.tractbilling.com/t/s/r/1.33/billingAccounts/240680/applyPayment
<applyPayment xmlns="http://www.tractbilling.com/billing/1_31/domain">
<billingAccount eid="240680"/>
<invoice eid="602814"/>
<payment amount="1" useRecurringPayment="false">
<creditCardPayment cardType="VISA" cardHolderFirstName="Jennifer"
cardHolderLastName="Smith" cardIdentifierNumber="4111111111111111"
cardVerificationNumber="123" cardExpiration="12/2016" description="Test Desc"/>
</payment>
</applyPayment>
Add Recurring Payment to a Billing Account
See AddRecurringPaymentToBillingAccount for more details.
In the following example, the Billing Account EID value of "244064" was learned through a separate Query.
POST https://my.tractbilling.com/t/s/r/1.33/billingAccounts/244064/addRecurringPayment
<addRecurringPaymentToBillingAccount xmlns="http://www.tractbilling.com/billing/1_31/domain">
<billingAccount eid="244064"/>
<recurringPayment>
<creditCardPaymentMethod cardType="VISA" cardHolderFirstName="Susan"
cardHolderLastName="Smith" cardIdentifierNumber="4111111111111111" cardExpiration="12/2015"/>
</recurringPayment>
</addRecurringPaymentToBillingAccount>
Change Service on a Billing Account
See ChangeServiceCommand for more details.
In the following example, the Billing Account EID value of "277222" and the Service EID value of "136" and the Product EID value of "14130" were learned through separate Queries.
POST https://my.tractbilling.com/t/s/r/1.33/billingAccounts/277222/changeService
<changeService xmlns="http://www.tractbilling.com/billing/1_31/domain">
<service eid="136"/>
<order note="Simple Subscription Order">
<orderItems>
<orderItem quantity="1" description="Change Service">
<product eid="14130"/>
</orderItem>
</orderItems>
<billingAccount eid="277222"></order>
</changeService>
Suspend a Billing Account
See SuspendBillingAccount for more details. In the following example, the Billing Account EID value of "220011" and the SuspensionReason EID value of "211" were learned through separate Queries.
POST https://my.tractbilling.com/t/s/r/1.33/billingAccounts/220011/suspend
<suspendBillingAccount xmlns="http://www.tractbilling.com/billing/1_31/domain">
<billingAccount eid="220011"/>
<reason eid="211"/>
</suspendBillingAccount>
Resume a Billing Account
See ResumeBillingAccount for more details. In the following example, the Billing Account EID value "220011" of was learned through a separate Query.
POST https://my.tractbilling.com/t/s/r/1.33/billingAccounts/220011/resume
<resumeBillingAccount xmlns="http://www.tractbilling.com/billing/1_31/domain">
<billingAccount eid="220011"/>
<startDate>2012-12-07T14:10:00.0</startDate>
<notes>Notes go here, for example, the reason for resuming this Billing Account.</notes>
</resumeBillingAccount>
Deactivate a Billing Account
See DeactivateBillingAccount for more details.
Important: Deactivating a Billing Account is permanent and the Billing Account cannot be resumed or reactivated. If that Billing Account is wanted again, a new one must be created.
In the following example, the Billing Account EID value "2422" of was learned through a separate Query of Billing Account and the Deactivation Reason EID value of "278" was learned through a query of DeactivationReason.
POST https://my.tractbilling.com/t/s/r/1.33/billingAccounts/2422/deactivate
<deactivateBillingAccount xmlns="http://www.tractbilling.com/billing/1_31/domain">
<billingAccount eid="2422"/>
<reason eid="278"/>
</deactivateBillingAccount>
Create a Billing Account
To create a Billing Account using REST through the Gotransverse API, see the table in the following section Create or Query a Billing Account for the list of information you need to create the Billing Account.
The following example shows a Billing Account created and added to a dailyBillCycle (which has the EID of "4384") and the billingAccountCategory (with an EID of "749") was used on this Billing Account. Both of these EID values were learned through Queries of BillCycle and BillingAccountCategory.
POST https://my.tractbilling.com/t/s/r/1.33/billingAccounts
<billingAccount billType="EMAIL" xmlns="http://www.tractbilling.com/billing/1_31/domain">
<dailyBillCycle eid="4384"/>
<organization name="Smith Services">
<addresses>
<emailAddress purpose="PRIMARY"
email="DanSmith@SmithServicesInterestingCompany.com"/>
<postalAddress purpose="BILLING" country="USA" city="Austin" regionOrState="TX"
attention="Jimmy Smith" postalCode="78701" line1="123 Interesting Street"/>
<telecomAddress purpose="OFFICE" dialingPrefix="9" countryCode="1" areaCode="512"
number="5551212" extension="123"/>
</addresses>
</organization>
<billingAccountCategory eid="749"/>
</billingAccount>
Update Information in a Billing Account
To update information in a Billing Account, use the Update function. This example shows the Billing Account with an EID value of "277443" and using the BillingAccountCategory of "749," both learned through separate Queries, having its billType changed to "PAPER."
PUT https://my.tractbilling.com/t/s/r/1.33/billingAccounts/277443
<billingAccount eid="277443" billType="PAPER" automaticRecurringPayment="true" xmlns="http://www.tractbilling.com/billing/1_31/domain">
<billingAccountCategory eid="749"/>
</billingAccount>
Add a Responsible Account
POST https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/addResponsibleAccount
<addResponsibleAccount xmlns="http://www.tractbilling.com/billing/1_31/domain" xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain/rest">
<billingAccount accountNum="366" billType="EMAIL" automaticRecurringPayment="false" status="ACTIVE" pendingChargesTotal="50.00" balance="0.00" startDate="2016-03-15T13:08:09.000-05:00" taxExempt="false" currencyType="USD" nextInvoiceDate="2015-04-12T00:00:00.000-05:00" eid="373" queryScope="SHALLOW">
<dailyBillCycle eid="6" queryScope="EID"/>
<person eid="381" queryScope="EID"/>
<billingAccountCategory eid="4" queryScope="EID"/>
<services pageNumber="1" pageSize="50" totalElements="1" elementCount="0" totalPages="1"/>
<pendingCharges pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
<customFieldValues pageNumber="1" pageSize="50" totalElements="0" elementCount="0" totalPages="0"/>
<paymentTerm termDays="0" graceDays="0" eid="6" queryScope="EID"/>
<responsibleAccount eid="373" queryScope="EID"/>
</billingAccount>
<responsibleAccount accountNum="367" billType="EMAIL" automaticRecurringPayment="false" status="ACTIVE" pendingChargesTotal="50.00" balance="0.00" startDate="2016-03-15T13:08:10.000-05:00" taxExempt="false" currencyType="USD" nextInvoiceDate="2015-04-12T00:00:00.000-05:00" eid="374" queryScope="SHALLOW">
<dailyBillCycle eid="6" queryScope="EID"/>
<person eid="382" queryScope="EID"/>
<billingAccountCategory eid="4" queryScope="EID"/>
<services pageNumber="1" pageSize="50" totalElements="1" elementCount="0" totalPages="1"/>
<pendingCharges pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
<customFieldValues pageNumber="1" pageSize="50" totalElements="0" elementCount="0" totalPages="0"/>
<paymentTerm termDays="0" graceDays="0" eid="6" queryScope="EID"/>
<responsibleAccount eid="374" queryScope="EID"/>
</responsibleAccount>
</addResponsibleAccount>
Change a Responsible Account
POST https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/changeResponsibleAccount
<changeResponsibleAccount xmlns="http://www.tractbilling.com/billing/1_31/domain" xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain/rest">
<billingAccount accountNum="366" billType="EMAIL" automaticRecurringPayment="false" status="ACTIVE" pendingChargesTotal="50.00" balance="0.00" startDate="2016-03-15T13:08:09.000-05:00" taxExempt="false" currencyType="USD" nextInvoiceDate="2015-04-12T00:00:00.000-05:00" eid="373" queryScope="SHALLOW">
<dailyBillCycle eid="6" queryScope="EID"/>
<person eid="381" queryScope="EID"/>
<billingAccountCategory eid="4" queryScope="EID"/>
<services pageNumber="1" pageSize="50" totalElements="1" elementCount="0" totalPages="1"/>
<pendingCharges pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
<customFieldValues pageNumber="1" pageSize="50" totalElements="0" elementCount="0" totalPages="0"/>
<paymentTerm termDays="0" graceDays="0" eid="6" queryScope="EID"/>
<responsibleAccount eid="373" queryScope="EID"/>
</billingAccount>
<responsibleAccount accountNum="368" billType="EMAIL" automaticRecurringPayment="false" status="ACTIVE" pendingChargesTotal="50.00" balance="0.00" startDate="2016-03-15T13:08:11.000-05:00" taxExempt="false" currencyType="USD" nextInvoiceDate="2015-04-12T00:00:00.000-05:00" eid="375" queryScope="SHALLOW">
<dailyBillCycle eid="6" queryScope="EID"/>
<person eid="383" queryScope="EID"/>
<billingAccountCategory eid="4" queryScope="EID"/>
<services pageNumber="1" pageSize="50" totalElements="1" elementCount="0" totalPages="1"/>
<pendingCharges pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
<customFieldValues pageNumber="1" pageSize="50" totalElements="0" elementCount="0" totalPages="0"/>
<paymentTerm termDays="0" graceDays="0" eid="6" queryScope="EID"/>
<responsibleAccount eid="375" queryScope="EID"/>
</responsibleAccount>
</changeResponsibleAccount>
Remove a Responsible Account
POST https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid}/removeResponsibleAccount
<removeResponsibleAccount xmlns="http://www.tractbilling.com/billing/1_31/domain" xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain/rest">
<billingAccount accountNum="366" billType="EMAIL" automaticRecurringPayment="false" status="ACTIVE" pendingChargesTotal="50.00" balance="0.00" startDate="2016-03-15T13:08:09.000-05:00" taxExempt="false" currencyType="USD" nextInvoiceDate="2015-04-12T00:00:00.000-05:00" eid="373" queryScope="SHALLOW">
<dailyBillCycle eid="6" queryScope="EID"/>
<person eid="381" queryScope="EID"/>
<billingAccountCategory eid="4" queryScope="EID"/>
<services pageNumber="1" pageSize="50" totalElements="1" elementCount="0" totalPages="1"/>
<pendingCharges pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
<customFieldValues pageNumber="1" pageSize="50" totalElements="0" elementCount="0" totalPages="0"/>
<paymentTerm termDays="0" graceDays="0" eid="6" queryScope="EID"/>
<responsibleAccount eid="373" queryScope="EID"/>
</billingAccount>
<responsibleAccount accountNum="368" billType="EMAIL" automaticRecurringPayment="false" status="ACTIVE" pendingChargesTotal="50.00" balance="0.00" startDate="2016-03-15T13:08:11.000-05:00" taxExempt="false" currencyType="USD" nextInvoiceDate="2015-04-12T00:00:00.000-05:00" eid="375" queryScope="SHALLOW">
<dailyBillCycle eid="6" queryScope="EID"/>
<person eid="383" queryScope="EID"/>
<billingAccountCategory eid="4" queryScope="EID"/>
<services pageNumber="1" pageSize="50" totalElements="1" elementCount="0" totalPages="1"/>
<pendingCharges pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
<customFieldValues pageNumber="1" pageSize="50" totalElements="0" elementCount="0" totalPages="0"/>
<paymentTerm termDays="0" graceDays="0" eid="6" queryScope="EID"/>
<responsibleAccount eid="375" queryScope="EID"/>
</responsibleAccount>
</removeResponsibleAccount>
Create a Bill on Demand
This example of creating a bill on demand shows the Billing Account with an EID value of "2269677" learned through a separate query.
POST https://my.tractbilling.com/t/s/r/1.33/billingAccounts/2269677/billOnDemand
<billOnDemandBillingAccount xmlns="http://www.tractbilling.com/billing/1_33/domain" endDate="2017-11-15T16:15:00.000-05:00" description="Bill on Demand for Customer Smith" name="Smith Bill on Demand" usePaymentTerm="false" invoiceDate="2017-11-16T00:00:00.000-05:00" invoiceDueDate="2017-12-16T00:00:00.000-05:00" autoApprove="true"> <billingAccount eid="2269677"> </billOnDemandBillingAccount>
Refer to the following topics for more information: