Budgets - Edit a budget period

API Url

Use it to edit a budget period

PUT

http://localhost:16010/ProMarkREST/web/System/Budgets/{id}/periods/{periodId}

Permissions: user

Request headers

Field	Type	Description
Accept-Language`optional`	String	=en-GB Language use for localization.
X-Client`optional`	String	=Client type. Allowed values:`"Portal""Mobile""Admin"`
X-Role`optional`	Number	ProMark role (1: Employee, 2: User). Allowed values:`{12}`
X-WebPart-Id`optional`	Number	Unique web-part identifier.

Path parameters

Field	Type	Description
id	Number	Budget id.
periodId	Number	Budget period id.

Query parameters

Field	Type	Description
contextId`optional`	String	Context id
contextType`optional`	Number	Context type `1`: Department `2`: Group `3`: Approval group
from`optional`	Date	Start date for the budget periods
to`optional`	Date	End date for the budget periods

Parameter

Field	Type	Description
request	Object	Main object containing the request data.
data	Object	Object containg data to be uploaded.
budgetPeriods	Object[]
budgetId	String	The budget ID for which the period is created
budgetValue	Number	The budget value.
contextId	String	The parent id of the budget.
contextType	Number	The parent type of the budget. `1`: Department `2`: Group `3`: Approval group
from	Date	Start date of the new period
periodDays	Object[]	Array with information about the days in the period.
calculatedValue	Number	The calculated value for the day.
day	Date	Date of a day in period
factor	Number	Factor of the day
rotationLength	Number	The length of the period.

Request example:

{
   "request": {
      "data": {
         "budgetPeriods": [
            {
               "budgetId": "123",
               "from": "2020-05-12",
               "rotationLength": 7,
               "budgetValue": 2000,
               "contextType": 1,
               "contextId": "Dept1",
               "periodDays": [{
                     "periodId": 44452,
                     "day": "2020-05-12",
                     "factor": 1,
                     "calculatedValue": 100,
                     "actualValue": 200
                  },
                  {
                     "periodId": 44452,
                     "day": "2020-05-13",
                     "factor": 1,
                     "calculatedValue": 200
                  },
                  {
                     "periodId": 4452,
                     "day": "2020-05-14",
                     "factor": 1,
                     "calculatedValue": 200
                  },
                  {
                     "periodId": 44452,
                     "day": "2020-05-15",
                     "factor": 1,
                     "calculatedValue": 200
                  },
                  {
                     "periodId": 44452,
                     "day": "2020-05-16",
                     "factor": 2,
                     "calculatedValue": 400
                  },
                  {
                     "periodId": 44452,
                     "day": "2020-05-17",
                     "factor": 2,
                     "calculatedValue": 400
                  },
                  {
                     "periodId": 44452,
                     "day": "2020-05-18",
                     "factor": 2,
                     "calculatedValue": 400
                  }]
            }
          ]
      }
   }
}

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.