```html lineNumbers 100 Request has completed successfully 132 3 Report has completed successfully ``` ## Run a transaction summary report [#run-a-transaction-summary-report] ### Request [#request-1] The request demonstrates how to run a Transaction Summary Report with a page size of 50 lines starting on October 13 at 12:00AM and ending on October 15 at 12:59 and 59 seconds PM. ` User Vendor Partner Password TransactionSummaryReport start_date 2020-10-13 end_date 2020-10-15 50 ` ### Response [#response-1] In the response to running the Transaction Summary Report, the response code of `100` indicates that the request completed successfully. The status code of 3 indicates that the report completed successfully and the `reportId` 131 is returned for future reverence in calls inquiring about this report.

```html lineNumbers 100 Request has completed successfully 133 3 Report has completed successfully ``` ## Get results by report ID [#get-results-by-report-id] ### Request [#request-2] In the request to get the results by report ID, `reportId` 131 specifies the report for which results are being requested. The `reportId` 131 was returned in a previous call to run the report.

```html lineNumbers 131 ``` ### Response [#response-2] In the response to getting results by report ID, the response code of `100` indicates that the request completed successfully. The status code of 3 indicates that the report with `reportId` 131 completed successfully.

```html lineNumbers 100 Request has completed successfully 131 3 Report has completed successfully ``` ## Get metadata [#get-metadata] ### Request [#request-3] The request demonstrates how to obtain the formatting information for the report with `reportId` 131.

```html lineNumbers 131 ``` ### Response [#response-3] In the response to retrieving metadata, the response code of `100` indicates that the request completed successfully. The response returns the number columns, rows, pages, and lines per page are present in the format of the report with `reportID` 131. For each table column, the response returns the column heading.

```html lineNumbers 100 Request has completed successfully 13 1 50 11 Transaction ID string Trans Time date Trans Type string Tender Type string Account Number string Expires string Amount string Result number Reponse Msg string Comment1 string Comment2 string ``` The format returned by this sample is: Note The last four digits of the account number are returned. | Transaction ID | Trans Time | Trans Type | Tender Type | Account Number | Expires | Amount | Result | Response Msg | Comment1 | Comment2 | | -------------- | ------------------- | ---------- | ----------- | -------------- | ------- | ------ | ------ | ------------ | -------- | -------- | | V89A0A000087 | 2014-09-07 17:45:07 | S | O | 1111 | 01/15 | A1000 | O | Approved | | | | V89A0A000088 | 2014-09-07 17:45:09 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A000089 | 2014-09-07 17:48:20 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A00008A | 2014-09-07 17:52:03 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A00008B | 2014-09-07 17:53:07 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A00008C | 2014-09-07 17:53:32 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A00008D | 2014-09-07 17:54:20 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A00008E | 2014-09-07 17:56:02 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A00008F | 2014-09-07 17:56:33 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A000090 | 2014-09-07 18:01:31 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A000091 | 2014-09-07 18:01:44 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A000092 | 2014-09-07 18:02:19 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A000093 | 2014-09-07 18:03:09 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | ## Get data [#get-data] ### Request [#request-4] In the request to retrieve data, `reportId` 131 specifies the report for which the data is being requested. The `reportId` value of 131 was returned in a previous call to run the report. The `pageNum` refers to the page number desired in a multi-page report.

```html lineNumbers 131 1 ``` ### Response [#response-4] In the response to retrieving data, the response code of `100` indicates that the request completed successfully. The response returns the data in each of the columns and rows of the report with `reportID` 131.

``` 100 Request has completed successfully V89A0A000087 2014-09-07 17:45:08 S 0 4111XXXXXXXX1111 01/07 A1000 0 Approved V89A0A000088 2014-09-07 17:46:09 S 0 4111XXXXXXXX1111 01/15 A1000 0 Approved V89A0A000089 2014-09-07 17:48:20 S 0 4111XXXXXXXX1111 01/15 A1000 0 Approved V89A0A00008A 2014-09-07 17:52:03 S 0 4111XXXXXXXX1111 01/15 A1000 0 Approved V89A0A00008B 2014-09-07 17:53:07 S 0 4111XXXXXXXX1111 01/15 A1000 0 Approved V89A0A00008C 2014-09-07 17:53:32 S 0 4111XXXXXXXX1111 01/15 A1000 columnData> data>0 Approved V89A0A00008D 2014-09-07 17:54:20 S 0 4111XXXXXXXX1111 01/07 A1000 0 Approved V89A0A00008E 2014-09-07 17:56:02 S data>0 4111XXXXXXXX1111 01/15 A1000 0 Approved V89A0A00008F 2014-09-07 17:56:33 S 0 4111XXXXXXXX1111 01/15 A1000 0 Approved V89A0A000090 2014-09-07 18:01:31 S 0 4111XXXXXXXX1111 01/15 A1000 24 Unknown error V89A0A000091 2014-09-07 18:01:44 S 0 4111XXXXXXXX1111 12/15 A1000 0 Approved V89A0A000092 2014-09-07 18:02:19 S 0 4111XXXXXXXX1111 12/15 A1000 0 Approved V89A0A000093 2014-09-07 18:03:09 S 0 4111XXXXXXXX1111 12/15 A1000 0 Approved 1 ``` ### Response [#response-5] The data is returned in the following tabular format of 13 rows and 11 columns: | Transaction ID | Trans Time | Trans Type | Tender Type | Account Number | Expires | Amount | Result | Response Msg | Comment1 | Comment2 | | -------------- | ------------------- | ---------- | ----------- | -------------- | ------- | ------ | ------ | ------------ | -------- | -------- | | V89A0A000087 | 2014-09-07 17:45:07 | S | O | 1111 | 01/15 | A1000 | O | Approved | | | | V89A0A000088 | 2014-09-07 17:45:09 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A000089 | 2014-09-07 17:48:20 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A00008A | 2014-09-07 17:52:03 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A00008B | 2014-09-07 17:53:07 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A00008C | 2014-09-07 17:53:32 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A00008D | 2014-09-07 17:54:20 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A00008E | 2014-09-07 17:56:02 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A00008F | 2014-09-07 17:56:33 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A000090 | 2014-09-07 18:01:31 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A000091 | 2014-09-07 18:01:44 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A000092 | 2014-09-07 18:02:19 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | | V89A0A000093 | 2014-09-07 18:03:09 | S | O | 1111 | 01/07 | A1000 | O | Approved | | | ## Create a report template [#create-a-report-template] ### Request [#request-5] This request creates a report template from a Daily Activity Report with a report template name of ' MyTemplate ' . It sets the values of two parameters (`name1` and `name2`). The parameter names and values are stored in the database.

```html lineNumbers authRequest> My Template DailyActivityReport name1 value1 name2 value2 ``` ### Response [#response-6] In the response to creating a report template, the response code of `100` indicates that the request completed successfully. Thereafter, when ' My Template ' is run, these parameters are automatically retrieved from the database and used to generate the Daily Activity Report.

```html lineNumbers 100 Request has completed successfully ``` ## Update a report template [#update-a-report-template] ### Request [#request-6] The request specifies the report template to update by its name 'My Template' and the report type (Daily Activity Report) upon which it was originally based.Updating a report template is not an additive process. It replaces the parameters and values previously defined for 'My Template' with new parameters and values.

```html lineNumbers My Template DailyActivityReport name3 value3 name4 value4 ``` ### Response [#response-7] In the response to updating a report template, the response code of `100` indicates that the request completed successfully. The `getTemplateRequest` can be used to check the new parameters and values.

```html lineNumbers 100 Request has completed successfully ``` ## Get a report template [#get-a-report-template] ### Request [#request-7] The request specifies the report template name ' My Template ' to retrieve.

```html lineNumbers My Template ``` ### Response [#response-8] In the response to retrieving a report template, the response code of `100` indicates that the request completed successfully. The response returns the report template name, the report type (Daily Activity Report) upon which it was originally based, as well as the parameter names and values defined for this report template.

```html lineNumbers 100 Request has completed successfully My Template DailyActivityReport name3 value3 name4 value4 ``` ## Delete a report template [#delete-a-report-template] ### Request [#request-8] The request to delete a report template includes the `templateName` ' My Template ' .

```html lineNumbers My Template ``` ### Response [#response-9] In the response to deleting a report template, the response code of `100` indicates that the request completed successfully. If you were to specify a bogus name for the report template (in error), the responseCode `113` is returned with the responseMsg " Unknown template requested " .

```html lineNumbers 113 Unknown template requested ``` ## Create a schedule [#create-a-schedule] ### Request [#request-9]

```html lineNumbers My Schedule My Template false ``` ### Response [#response-10] In the response to creating a schedule, the response code of `100` indicates that the request completed successfully.

```html lineNumbers 100 Request has completed successfully ``` ## Get a schedule [#get-a-schedule] ### Request [#request-10]

```html lineNumbers My Schedule ``` ### Response [#response-11] In the response to getting a schedule, the response code of `100` indicates that the request completed successfully. The response returns the name of the schedule, the report template scheduled, and the schedule (daily).

```html lineNumbers 100 Request has completed successfully My Schedule My Template false ``` ## Update a schedule [#update-a-schedule] ### Request [#request-11]

```html lineNumbers My Schedule My Template false ``` ### Response [#response-12] In the response to updating a schedule, the response code of `100` indicates that the request completed successfully.

```html lineNumbers 100 Request has completed successfully ``` ## Delete a schedule [#delete-a-schedule] ### Request [#request-12]

```html lineNumbers My Schedule ``` ### Response [#response-13] In the response to deleting a schedule, the response code of `100` indicates that the request completed successfully.

```html lineNumbers 100 Request has completed successfully ``` ## Run a transaction ID search [#run-a-transaction-id-search] ### Request [#request-13]

```html lineNumbers TransactionIDSearch transaction_id V89A0A000264 50 ``` ### Response [#response-14] In the response to running the transaction ID search, the `responseCode` of 100 indicates that the report completed successfully. The `reportId` 132 returned is used to uniquely identify this report in future calls to the Reporting API.

```html lineNumbers 100 Request has completed successfully 132 3 Report has completed successfully ``` ## Run a profile - Next payment date report [#run-a-profile---next-payment-date-report] ### Request [#request-14]

```html lineNumbers RBProfileNPDReport start_date 2014-06-22 00:00:00 end_date 2015-08-30 00:00:00 50 ``` ### Response [#response-15]

```html lineNumbers 100 Request has completed successfully 132 3 Report has completed successfully ``` ## Run a profile - Profile modified date report [#run-a-profile---profile-modified-date-report] ### Request [#request-15]

```html lineNumbers RBProfilePMDReport start_date 2013-06-22 00:00:00 end_date 2013-08-30 00:00:00 50 ``` ### Response [#response-16]

```html lineNumbers 100 Request has completed successfully 132 3 Report has completed successfully ```