Selecting Reports

This guide will walk through how to select report data from QuickBooks. Reports are generated views that QuickBooks produces for a given set of report parameters. The data is transient, meaning that a report you run today may differ when run tomorrow, even with the same parameters, because the underlying business data may have changed (new invoices were posted, for instance).

API Endpoint

Use the /endpoint/{company.endpointId}/selectReport endpoint to select reports.

company.endpointId is the value returned after calling /manage/company.
ReportName is the name of the report in QuickBooks as supported by Autofy
- BalanceSheet
- PandLBalanceSheet
- ProfitAndLoss
- ProfitAndLossDetail
- ProfitAndLossByClass
- ProfitAndLossBudgetOverview
- ProfitAndLossBudgetVsActual
- ARAgingDetail
- BalanceSheetByClass
- PLandBalanceSheet
- VendorExpenseSummary
- GeneralLedger
- AuditTrail

https://api.propelware.com/v1/endpoint/{company.endpointId}/selectReport?name={ReportName}&startTime={date}&endTime={date}

Make the following request:

curl --request GET \
  --url 'https://api.propelware.com/v1/endpoint/c67e83e28abe40e59164fbe5888a178b/selectReport?name=BalanceSheet&startTime=1%2f23%2f2009+12%3a38%3a28+PM&endTime=1%2f23%2f2019+12%3a38%3a28+PM' \
  --header 'cache-control: no-cache' \
  --header 'content-type: application/json' \
  --header 'authorization: {YOUR API KEY}' \

Response:

{
	"Meta": {
		"CommandGuid": null,
		"StatusCode": 0,
		"Severity": null,
		"Message": null
	},
	"Detail": {
		"Response": [{
			"ReportTypeName": "balancesheetstandard",
			"ReportType": 4,
			"StartDate": "2009-01-23T18:43:19Z",
			"EndDate": "2019-01-23T18:43:19Z",
			"Columns": ["Jan 23, 19"],
			"ReportLineData": [{
				"EntityRef": {
					"FullName": "Accounts Receivable",
					"ID": ""
				},
				"Values": ["200.00"]
			}, {
				"EntityRef": {
					"FullName": "Accounts Payable",
					"ID": ""
				},
				"Values": ["-409.74"]
			}, {
				"EntityRef": {
					"FullName": "AfCreditCardAcct",
					"ID": ""
				},
				"Values": ["279.50"]
			}, {
				"EntityRef": {
					"FullName": "Owners Equity",
					"ID": ""
				},
				"Values": ["61.42"]
			}]
		}]
	}
}