GET Budget/GetBudgetReport/{id}?removeZeroValues={removeZeroValues}

Gets the budget report.

Request Information

URI Parameters

Name	Type	Additional information	Description
id	integer	Required	The identifier.
removeZeroValues	bool	Required	if set to true [remove zero values].

Body Parameters

None.

Response Information

Resource Description

Comparative Profit And Loss Statement

Name	Type	Additional information
FromDate	date	None.
ToDate	date	None.
IsComparative	bool	None.
IsBudget	bool	None.
ShowVariance	bool	None.
Periods	Collection of Period Grouping	None.
SalesLines	Collection of Comparative Profit And Loss Statement Line	None.
CostOfSalesLines	Collection of Comparative Profit And Loss Statement Line	None.
GrossProfit	Collection of nullable decimal	None.
OtherIncomeLines	Collection of Comparative Profit And Loss Statement Line	None.
ExpenseLines	Collection of Comparative Profit And Loss Statement Line	None.
NetProfitBeforeTax	Collection of nullable decimal	None.
Tax	Collection of decimal	None.
NetProfitAfterTax	Collection of nullable decimal	None.
SalesTotal	Collection of decimal	None.
CostOfSalesTotal	Collection of decimal	None.
OtherIncomeTotal	Collection of decimal	None.
ExpenseTotal	Collection of decimal	None.

Response Formats

application/json, text/json

Sample:

{
  "FromDate": "2024-04-20T00:00:00Z",
  "ToDate": "2024-04-20T00:00:00Z",
  "IsComparative": true,
  "IsBudget": true,
  "ShowVariance": true,
  "Periods": [
    {
      "Description": "Apr 24-Apr 24",
      "StartDate": "2024-04-20T00:00:00+10:00",
      "EndDate": "2024-04-20T00:00:00+10:00",
      "PeriodComparativeType": 0
    },
    {
      "Description": "Apr 24-Apr 24",
      "StartDate": "2024-04-20T00:00:00+10:00",
      "EndDate": "2024-04-20T00:00:00+10:00",
      "PeriodComparativeType": 0
    }
  ],
  "SalesLines": [
    {
      "AccountId": 1,
      "Description": "sample string 2",
      "Total": [
        1.0,
        2.0
      ],
      "IsSpecialLine": true
    },
    {
      "AccountId": 1,
      "Description": "sample string 2",
      "Total": [
        1.0,
        2.0
      ],
      "IsSpecialLine": true
    }
  ],
  "CostOfSalesLines": [
    {
      "AccountId": 1,
      "Description": "sample string 2",
      "Total": [
        1.0,
        2.0
      ],
      "IsSpecialLine": true
    },
    {
      "AccountId": 1,
      "Description": "sample string 2",
      "Total": [
        1.0,
        2.0
      ],
      "IsSpecialLine": true
    }
  ],
  "GrossProfit": [
    1.0,
    1.0
  ],
  "OtherIncomeLines": [
    {
      "AccountId": 1,
      "Description": "sample string 2",
      "Total": [
        1.0,
        2.0
      ],
      "IsSpecialLine": true
    },
    {
      "AccountId": 1,
      "Description": "sample string 2",
      "Total": [
        1.0,
        2.0
      ],
      "IsSpecialLine": true
    }
  ],
  "ExpenseLines": [
    {
      "AccountId": 1,
      "Description": "sample string 2",
      "Total": [
        1.0,
        2.0
      ],
      "IsSpecialLine": true
    },
    {
      "AccountId": 1,
      "Description": "sample string 2",
      "Total": [
        1.0,
        2.0
      ],
      "IsSpecialLine": true
    }
  ],
  "NetProfitBeforeTax": [
    1.0,
    1.0
  ],
  "Tax": [
    1.0,
    2.0
  ],
  "NetProfitAfterTax": [
    1.0,
    1.0
  ],
  "SalesTotal": [
    1.0,
    2.0
  ],
  "CostOfSalesTotal": [
    1.0,
    2.0
  ],
  "OtherIncomeTotal": [
    1.0,
    2.0
  ],
  "ExpenseTotal": [
    1.0,
    2.0
  ]
}