BillCycleRun
Version: 1.33
Parameters
Extends: TractObject
| Element | Type | Required? | Description |
|
billCycle |
billCycle |
Y |
The Bill Cycle executed in this Bill Cycle run. |
| Attribute | Required? | Datatype | Description |
|
sequence |
int |
The TRACT assigned identifier of this Bill Cycle run. |
|
|
status |
BillCycleRunStatus |
NEW OPEN READY SCHEDULED RUNNING COMPLETED APPROVED CANCELED ERRED SIMULATE PAUSED |
|
|
step |
BillCycleRunStep |
AVAILABLE CALCULATE_BILLABLE_USAGE GENERATE_KPIS GENERATE_SAMPLE_INVOICES DISTRIBUTE_INVOICES RETRY_DISTRIBUTE_INVOICES RENDER_INVOICES RETRY_RENDER_INVOICES POST_TAX POST_ACCOUNTS CALCULATE_BILLABLE_CHARGES CANCELING AUTO_RECURRING_PAY APPROVAL GENERATE_ARTIFACTS |
|
|
statusDate |
dateTime |
Time stamp for when the Bill Cycle enters the status. |
|
|
openDate |
dateTime |
Time stamp indicating when the Bill Cycle run started. |
|
|
closeDate |
dateTime |
Time stamp indicating when the Bill Cycle run ended. |
|
|
scheduledRunDate |
dateTime |
The scheduled day to run the Bill Cycle. |
|
|
invoiceDueDate |
dateTme |
The date by which your customer must pay the Invoice to avoid late payment fees. |
|
| processedInvoiceCount |
long |
The number of invoices created by this Bill Cycle run. |
|
| errorMsg |
string |
Message describing any errors with this Bill Cycle run. |
|
| invoiceDate |
dateTime |
The Invoice Date is the date that the invoices are posted to the General Ledger. |
|
| usePaymentTerm |
boolean |
Use Payment Term? Payment Terms are the period of time between the Invoice Date and when the Invoice is considered Past Due. |
|
|
globalStatus |
BillCycleRunGlobalStatus |
SIMULATE |
Querying BillCycleRun
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 |
|
billCycleEid |
Long |
|
billCycleName |
String |
|
sequence |
Integer |
|
status |
run.BillCycleRunStatus |
|
step |
run.BillCycleRunStep |
|
openDate |
Timestamp |
|
closeDate |
Timestamp |
|
globalStatus |
run.BillCycleRunGlobalStatus |
REST Endpoints
|
getBillCycleRuns |
GET |
https://my.tractbilling.com/t/s/r/1.33/billCycleRuns |
|
cancel |
POST |
https://my.tractbilling.com/t/s/r/1.33/billCycleRuns/{eid: \d+}/cancel |
|
getBillCycleRun |
GET |
https://my.tractbilling.com/t/s/r/1.33/billCycleRuns/{eid: \d+} |
|
approve |
POST |
https://my.tractbilling.com/t/s/r/1.33/billCycleRuns/{eid: \d+}/approve |
|
run |
POST |
https://my.tractbilling.com/t/s/r/1.33/billCycleRuns/{eid: \d+}/run |
|
simulate |
POST |
https://my.tractbilling.com/t/s/r/1.33/billCycleRuns/{eid: \d+}/simulate |
Sample Requests and Responses
SOAP
Run a Bill Cycle
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.tractbilling.com/billing/1_31/service" xmlns:dom="http://www.tractbilling.com/billing/1_31/domain"> <soapenv:Header/> <soapenv:Body> <ser:command> <ser:commandRequest> <runBillCycleRun scheduledDate="2015-02-25T00:00:00.000-06:00" usePaymentTerm="true" invoiceDate="2015-02-25T00:00:00.000-06:00" invoiceDueDate="2015-02-25T00:00:00.000-06:00"> <billCycleRun eid="2073"/> </runBillCycleRun> </ser:commandRequest> </ser:command> <ser:authorize/> <ser1:authorize xmlns:ser1="http://www.tractbilling.com/billing/1_31/service"/> </soapenv:Body> </soapenv:Envelope>
Simulate a Bill Cycle
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.tractbilling.com/billing/1_31/service" xmlns:dom="http://www.tractbilling.com/billing/1_31/domain"> <soapenv:Header/> <soapenv:Body> <ser:command> <ser:commandRequest> <simulateBillCycleRun scheduledDate="2015-02-25T00:00:00.000-06:00" usePaymentTerm="true" invoiceDate="2015-03-25T00:00:00.000-06:00" invoiceDueDate="2015-03-25T00:00:00.000-06:00"> <billCycleRun eid="2073"/> </simulateBillCycleRun> </ser:commandRequest> </ser:command> <ser:authorize/> <ser1:authorize xmlns:ser1="http://www.tractbilling.com/billing/1_31/service"/> </soapenv:Body> </soapenv:Envelope>
Cancel a Bill Cycle Run
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.tractbilling.com/billing/1_31/service" xmlns:dom="http://www.tractbilling.com/billing/1_31/domain"> <soapenv:Header/> <soapenv:Body> <ser:command> <ser:commandRequest> <cancelBillCycleRun> <billCycleRun eid="2073"/> </cancelBillCycleRun> </ser:commandRequest> </ser:command> <ser:authorize/> <ser1:authorize xmlns:ser1="http://www.tractbilling.com/billing/1_31/service"/> </soapenv:Body> </soapenv:Envelope>
REST
Run a Bill Cycle Run
POST https://my.tractbilling.com/t/s/r/1.33/billCycleRuns/2073/run
<runBillCycleRun xmlns="http://www.tractbilling.com/billing/1_31/domain" scheduledDate="2015-02-25T00:00:00.000-06:00" usePaymentTerm="true" invoiceDate="2015-02-25T00:00:00.000-06:00" invoiceDueDate="2015-02-25T00:00:00.000-06:00"> <billCycleRun eid="2073"/> </runBillCycleRun>
Simulate a Bill Cycle
POST https://my.tractbilling.com/t/s/r/1.33/billCycleRuns/2073/simulate
<simulateBillCycleRun xmlns="http://www.tractbilling.com/billing/1_31/domain" scheduledDate="2015-02-25T00:00:00.000-06:00" usePaymentTerm="true" invoiceDate="2015-03-25T00:00:00.000-06:00" invoiceDueDate="2015-03-25T00:00:00.000-06:00"> <billCycleRun eid="2073"/> </simulateBillCycleRun>
Cancel a Bill Cycle
POST https://my.tractbilling.com/t/s/r/1.33/billCycleRuns/2073/cancel
<cancelBillCycleRun xmlns="http://www.tractbilling.com/billing/1_31/domain"> <billCycleRun eid="2073"/> </cancelBillCycleRun>