General:
Services:
Resources:
Get Report
The Get Report query accepts a set of parameters and returns a JSON that includes an attribut called 'output' that contains an array of values representing the lines of the requested report. Each line is a set of pipe ( | ) delimited cells. To restore the report to a csv file, join the lines with a new line character ( \n ) and write to file.
Each report has it's own parameters which are described on the available reports page. Click the on the report you are interesetd in to see a description and a list of the required inputs.
Endpoint: https://www.dumpster.software/controller.html| Arguments | Req | Data Type | Example |
|---|---|---|---|
| command | Y | N/A | cmdBoxTWebAPIGetReports |
| key | Y | N/A | Value returned from the handshake |
| username | Y | N/A | To be issued |
| reportName | Y | varchar(150) | See available reports for details |
| params | Y | - - | See available reports for details |
Box Tracker Response: A JSON with the following fields:
| Field | Example | Explaination |
|---|---|---|
| status | 200 | See the Status Codes section |
| errorString | ERROR: Invalid Session Key | What, if anything, went wrong |
| time | 1594413406 | Unix Time Stamp (EST ) when the request was created |
| output | See sample output below | An array of values representing the lines of the requested report |
Sample Output:
Transaction Summary 2021-03-01 and 2021-03-31 Invoices Inv# |Date|Customer|Cust. Category|Job Site|Amount 4132|Mar 2, 2021|Johnson, Steve|Contractor|300 Mast Rd - Goffstown| 520.10 4138|Mar 2, 2021|Johnson, Steve|Contractor|11161 Howk Hollow - Lake Worth| 422.88 4140|Mar 2, 2021|Lyle Sheppard|Residential|99 Mast Rd - Goffstown| 1,010.86 4145|Mar 2, 2021|Yonda Sether|Residential|1941 S Church St - Smithfield| 1,060.86 4148|Mar 2, 2021|Bill Lee|Residential| - | 510.00 3991|Mar 3, 2021|Johnson, Steve|Contractor| - | 350.00 4153|Mar 3, 2021|Suzanna Smiley|Residential|287 Tibbetts Hill Rd - Goffstown| 1,036.86 4137|Mar 5, 2021|Johnson, Steve|Contractor|15 Norman Rd. - Goffstown| 350.00 4157|Mar 5, 2021|Hillary Walters|Residential|77 Main Street - Goffstown| 665.76 4158|Mar 5, 2021|Lilly Tomlin|Residential|23 Center Street - Goffstown| 588.10 4159|Mar 5, 2021|Billie Idol|Residential|88 Mast Rd - Goffstown| 717.90 4166|Mar 14, 2021|Anita Blake|Commercial| - | 680.00 4167|Mar 14, 2021|Dave Fowler|Residential| - | 510.00 4169|Mar 14, 2021|Kelly Hulder|Residential|900 MAst rd - Goffstown| 572.16 4172|Mar 15, 2021|Dave Winston|Residential|55 Mast Rd - Goffstown| 1,070.86 4178|Mar 16, 2021|HG Factory|Contractor|287 Tibbetts Hill Rd - Goffstown| 573.72 4180|Mar 16, 2021|Mary Smith|Residential|557 Mast Rd - Goffstown| 555.00 4183|Mar 18, 2021|marvin Wilson|Residential|75 N Mast St - Goffstown| 940.86 4194|Mar 22, 2021|James Moser|Contractor|287 Tibbetts Hill Rd - Goffstown| 930.86 4196|Mar 22, 2021|Sally Kelterson|Residential|88 Mast rd - Goffstown| 585.00 4203|Mar 24, 2021|Michael Johnson|Contractor|1 Tara Blvd - Nashua| 930.86 4207|Mar 24, 2021|Mary Johnson|Residential|55 Main Street - Goffstown| 175.00 4212|Mar 25, 2021|Holden Walters|Residential|77 Mast Rd - Goffstown| 1,010.86 4219|Mar 25, 2021|Mellany Sanders|Residential|88 MAst Rd - Goffstown| 1,120.86 4228|Mar 30, 2021|Sally Winstonsome|Residential|187 Tibbetts Hill Rd - Goffstown| 910.86 Total||||| 17,800.22