Qodex.ai

Allows you to retrieve report for Budget Summary

GET {{baseUrl}}/Reports/BudgetSummary?date=<date>&period=<integer>&timeframe=<integer>

Request Params

KeyDatatypeRequiredDescription
datestringThe date for the Bank Summary report e.g. 2018-03-31
periodstringThe number of periods to compare (integer between 1 and 12)
timeframestringThe period size to compare to (1=month, 3=quarter, 12=year)

HEADERS

KeyDatatypeRequiredDescription
xero-tenant-idstring(Required) Xero identifier for Tenant

RESPONSES

status: OK

{&quot;Id&quot;:&quot;9f1e2722-0d98-4669-890f-f8f4217c968b&quot;,&quot;Status&quot;:&quot;OK&quot;,&quot;ProviderName&quot;:&quot;provider-name&quot;,&quot;DateTimeUTC&quot;:&quot;/Date(1573755037865)/&quot;,&quot;Reports&quot;:[{&quot;ReportID&quot;:&quot;BudgetSummary&quot;,&quot;ReportName&quot;:&quot;Budget Summary&quot;,&quot;ReportType&quot;:&quot;BudgetSummary&quot;,&quot;ReportTitles&quot;:[&quot;Overall Budget&quot;,&quot;Budget Summary&quot;,&quot;Online Test 11&quot;,&quot;November 2019 to October 2022&quot;],&quot;ReportDate&quot;:&quot;14 November 2019&quot;,&quot;UpdatedDateUTC&quot;:&quot;/Date(1573755037865)/&quot;,&quot;Fields&quot;:[],&quot;Rows&quot;:[{&quot;RowType&quot;:&quot;Header&quot;,&quot;Cells&quot;:[{&quot;Value&quot;:&quot;Account&quot;},{&quot;Value&quot;:&quot;Jan-20&quot;},{&quot;Value&quot;:&quot;Apr-20&quot;},{&quot;Value&quot;:&quot;Jul-20&quot;},{&quot;Value&quot;:&quot;Oct-20&quot;},{&quot;Value&quot;:&quot;Jan-21&quot;},{&quot;Value&quot;:&quot;Apr-21&quot;},{&quot;Value&quot;:&quot;Jul-21&quot;},{&quot;Value&quot;:&quot;Oct-21&quot;},{&quot;Value&quot;:&quot;Jan-22&quot;},{&quot;Value&quot;:&quot;Apr-22&quot;},{&quot;Value&quot;:&quot;Jul-22&quot;},{&quot;Value&quot;:&quot;Oct-22&quot;}]},{&quot;RowType&quot;:&quot;Section&quot;,&quot;Title&quot;:&quot;&quot;,&quot;Rows&quot;:[{&quot;RowType&quot;:&quot;SummaryRow&quot;,&quot;Cells&quot;:[{&quot;Value&quot;:&quot;Gross Profit&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;}]}]},{&quot;RowType&quot;:&quot;Section&quot;,&quot;Title&quot;:&quot;&quot;,&quot;Rows&quot;:[{&quot;RowType&quot;:&quot;SummaryRow&quot;,&quot;Cells&quot;:[{&quot;Value&quot;:&quot;Total Expenses&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;}]}]},{&quot;RowType&quot;:&quot;Section&quot;,&quot;Title&quot;:&quot;&quot;,&quot;Rows&quot;:[{&quot;RowType&quot;:&quot;SummaryRow&quot;,&quot;Cells&quot;:[{&quot;Value&quot;:&quot;Net Profit&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;},{&quot;Value&quot;:&quot;0.00&quot;}]}]}]}]}