getBudgetByPage

get https://webservices-test.net-chef.com/budget/v1/getBudgetByPage

Retrieves Budget records for the Location, and Post Date, by pageNumber.
Use to retrieve data in smaller chunks.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

budgetDetails

array of objects

budgetDetails

object

budgetDetailDetails

array of objects

Budget item details.

budgetDetailDetails

object

budgetType

string

General Ledger budget value type.

PERCENT VALUE

budgetValue

number

The currency value budgeted for the General Ledger account.

glDescription

string

required

General Ledger category name. Required and referenced only when “GL Number” corresponds to “GL Number” in more than one Crunchtime General Ledger account

glNumber

string

required

General Ledger account number.

percentLevel

string

Percentage level grouping type.
1 = General ledger
2 = null
3 = PROFIT_AND_LOSS_GROUPING,
4 = PROFIT_AND_LOSS_SUBSTRUCTURE

GENERAL_LEDGER NULL PROFIT_AND_LOSS_GROUPING PROFIT_AND_LOSS_SUBSTRUCTURE

percentOfAccount

string

required

General Ledger grouping for the account. Required and referenced only when Budget Type is “Percentage of” (‘P’).

budgetHeaderDetails

object

Budget header item.

hasNext

boolean

totalPages

int32

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://webservices-test.net-chef.com/budget/v1/getBudgetByPage?pageNumber=1' \
3
     --header 'accept: application/json'


xxxxxxxxxx
21
 
1
{
2
  "budgetDetails": [
3
    {
4
      "budgetDetailDetails": [
5
        {
6
          "budgetType": "P",
7
          "budgetValue": 0.36,
8
          "glDescription": "CLEANING SUPPLIES",
9
          "glNumber": 687501,
10
          "percentLevel": 3,
11
          "percentOfAccount": "SLS"
12
        }
13
      ],
14
      "budgetHeaderDetails": {
15
        "postDate": "MM/dd/yyyy"
16
      }
17
    }
18
  ],
19
  "hasNext": true,
20
  "totalPages": 0
21
}

200Success

400Validation Error

401Authorization

404BUDGET_NOT_FOUND

500Unexpected Error

503System under maintenance

504Timeout