OperationRun
Version: 1.33
Parameters
Element | Query Key? | Required | Description |
billingAccount |
|||
Operation |
Attribute | Query Key? | Datatype | Required | Description |
type |
OperationRunType |
|||
actionType |
ActionType |
|||
actionName |
string |
|||
operationType |
OperationType |
|||
launchCondition |
string |
|||
status |
OperationStatus |
|||
startDate |
dateTime |
|||
endDate |
dateTime |
|||
emailAddress |
string |
|||
httpResponse |
string |
|||
attempts |
long |
REST Endpoints
/operationRuns
GET https://my.tractbilling.com/t/s/r/1.33/{eid: \d+}
/operationRuns to retrieve customer statement
GET http://localhost:8080/tract/s/r/1.32/operationRuns?actionRunEid={eid }
Use this REST endpoint to generate a customer statement PDF. The actionRunEid is found through the user interface
Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<operationRuns xmlns="http://www.tractbilling.com/billing/1_31/domain/rest" xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain" pageNumber="1" pageSize="50" totalElements="1" elementCount="1" totalPages="1">
<ns2:billingAccountOperationRun type="BILLING_ACCOUNT" actionType="BILLING_ACCOUNT" actionName="Account Notification" operationType="EMAIL" launchCondition="Day of the Month 0" status="COMPLETE" startDate="2016-10-06T16:20:00.000-05:00" endDate="2016-10-06T16:20:01.000-05:00" emailAddress="docs@gotransverse.com" attempts="1" eid="91" queryScope="SHALLOW">
<ns2:billingAccount eid="17" queryScope="EID"/>
<ns2:operation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:EmailOperation" eid="50" queryScope="EID"/>
</ns2:billingAccountOperationRun></operationRuns>
/operationRuns/latest/pdf
GET http://localhost:8080/tract/s/r/1.32/operationRuns/latest/pdf?actionRunEid={eid}
Download the most recently generated PDF of a customer statement for the specified actionRun.