GET Budget/Get?includeDetail={includeDetail}

Gets a list of Budgets.

Request Information

This method supports OData queries.

URI Parameters

Name	Type	Additional information	Description
includeDetail	bool	Default value is False

Body Parameters

None.

Response Information

Resource Description

This collection is wrapped in a paging response object.

Paging response of Budget

Name	Type	Additional information
TotalResults	integer	None.
ReturnedResults	integer	None.
Results	Collection of Budget	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalResults": 1,
  "ReturnedResults": 2,
  "Results": [
    {
      "ID": 1,
      "Description": "sample string 2",
      "BudgetItems": [
        {
          "ID": 1,
          "Account": {
            "ID": 1,
            "ReportingLevelType": 1,
            "Name": "sample string 2",
            "Category": {
              "Comment": "sample string 1",
              "Order": 6,
              "Description": "sample string 7",
              "ID": 8,
              "Modified": "2024-11-15",
              "Created": "2024-11-15"
            }
          },
          "BudgetItemPeriods": [
            {
              "ID": 1,
              "Date": "2024-11-15",
              "Total": 3.0
            },
            {
              "ID": 1,
              "Date": "2024-11-15",
              "Total": 3.0
            }
          ],
          "Total": 2.0,
          "AccountTypeId": 3
        },
        {
          "ID": 1,
          "Account": {
            "ID": 1,
            "ReportingLevelType": 1,
            "Name": "sample string 2",
            "Category": {
              "Comment": "sample string 1",
              "Order": 6,
              "Description": "sample string 7",
              "ID": 8,
              "Modified": "2024-11-15",
              "Created": "2024-11-15"
            }
          },
          "BudgetItemPeriods": [
            {
              "ID": 1,
              "Date": "2024-11-15",
              "Total": 3.0
            },
            {
              "ID": 1,
              "Date": "2024-11-15",
              "Total": 3.0
            }
          ],
          "Total": 2.0,
          "AccountTypeId": 3
        }
      ],
      "NumberOfPeriods": 3
    },
    {
      "ID": 1,
      "Description": "sample string 2",
      "BudgetItems": [
        {
          "ID": 1,
          "Account": {
            "ID": 1,
            "ReportingLevelType": 1,
            "Name": "sample string 2",
            "Category": {
              "Comment": "sample string 1",
              "Order": 6,
              "Description": "sample string 7",
              "ID": 8,
              "Modified": "2024-11-15",
              "Created": "2024-11-15"
            }
          },
          "BudgetItemPeriods": [
            {
              "ID": 1,
              "Date": "2024-11-15",
              "Total": 3.0
            },
            {
              "ID": 1,
              "Date": "2024-11-15",
              "Total": 3.0
            }
          ],
          "Total": 2.0,
          "AccountTypeId": 3
        },
        {
          "ID": 1,
          "Account": {
            "ID": 1,
            "ReportingLevelType": 1,
            "Name": "sample string 2",
            "Category": {
              "Comment": "sample string 1",
              "Order": 6,
              "Description": "sample string 7",
              "ID": 8,
              "Modified": "2024-11-15",
              "Created": "2024-11-15"
            }
          },
          "BudgetItemPeriods": [
            {
              "ID": 1,
              "Date": "2024-11-15",
              "Total": 3.0
            },
            {
              "ID": 1,
              "Date": "2024-11-15",
              "Total": 3.0
            }
          ],
          "Total": 2.0,
          "AccountTypeId": 3
        }
      ],
      "NumberOfPeriods": 3
    }
  ]
}