v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Budget Service

getBudgetByPage

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

get/budget/v1/getBudgetByPage

Query parameters

locationCodestring required

The Code that identifies the Location in Crunchtime.

pageNumberinteger

Retrieve one or more records by pageNumber. Use to retrieve data in smaller chunks. If left blank, the default is 1.

postDatestring required

The Post date in format dd-MMM-yy.

pageSizeinteger

Number of items to display per page.

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring required

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring required

User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

hasNextboolean
totalPagesinteger

Example response

{
  "budgetDetails": [
    {
      "budgetDetailDetails": [
        {
          "budgetType": "P",
          "budgetValue": 0.36,
          "glDescription": "CLEANING SUPPLIES",
          "percentOfAccount": "SLS"
        }
      ],
      "budgetHeaderDetails": {
        "postDate": "MM/dd/yyyy"
      }
    }
  ]
}