POST Budget/GetDefaultBudget

Gets the default Budget.

Request Information

URI Parameters

None.

Body Parameters

The request.

Budget Request Model
NameTypeAdditional informationDescription
NumberOfPeriods integer

None.

BudgetStartDate date

None.

Request Formats

application/json, text/json

Sample:
{
  "NumberOfPeriods": 1,
  "BudgetStartDate": "2021-10-24"
}

Response Information

Resource Description

Budget
NameTypeAdditional informationDescription
ID integer

None.

Description string

None.

BudgetItems Collection of Budget Item

None.

This is a list of Budget Lines

NumberOfPeriods integer

None.

Response Formats

application/json, text/json

Sample:
{
  "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": "2021-10-24",
          "Created": "2021-10-24"
        }
      },
      "BudgetItemPeriods": [
        {
          "ID": 1,
          "Date": "2021-10-24",
          "Total": 3.0
        },
        {
          "ID": 1,
          "Date": "2021-10-24",
          "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": "2021-10-24",
          "Created": "2021-10-24"
        }
      },
      "BudgetItemPeriods": [
        {
          "ID": 1,
          "Date": "2021-10-24",
          "Total": 3.0
        },
        {
          "ID": 1,
          "Date": "2021-10-24",
          "Total": 3.0
        }
      ],
      "Total": 2.0,
      "AccountTypeId": 3
    }
  ],
  "NumberOfPeriods": 3
}