Measure accounting effect

A measure accounting effect.

Create a measure accounting effect

Create a new measure accounting effect for a measure, an accounting ledger qualifier, an accounting legal entity qualifier and a budgeting period.

If the measure accounting effect for the measure and the budgeting period already exists, it will be updated if necessary.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing measure accounting effect information

value_plan
number or null <float>

The plan value of the measure budgeting effect.

value_actual
number or null <float>

The actual value of the measure budgeting effect.

measure
required
string or integer

The measure of the measure budgeting effect.

Without a measure the request will always return a 403 Forbidden response.

accounting_ledger_qualifier
required
string or integer

The accounting ledger qualifier of the measure budgeting effect.

accounting_legal_entity_qualifier
required
string or integer

The accounting legal entity qualifier of the measure budgeting effect.

budgeting_period
required
string

The name of the budgeting period of the measure budgeting effect.

The name must be provided in the following formats:

Period typeFormatExample
WeeklyJJJJ-CW-##2021-CW-20
MonthlyJJJJ-MMM2021-Mar
QuarterlyJJJJ-QQ2021-Q1
YearlyJJJJ2021
Financial yearJJJJ-JJJJ2021-2022

Responses
200

Successful operation

201

Successful operation

404

Not Found

422

Unprocessable Content

post/measureaccountingeffect
Request samples
application/json
{
  • "value_plan": 59.07105,
  • "value_actual": 37.11787,
  • "measure": "264a21089e5720c8dddc67986d5bab827a75b58e",
  • "accounting_ledger_qualifier": "47310",
  • "accounting_legal_entity_qualifier": "HHAG",
  • "accounting_period": "2022-May"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "73866a10d9c65dea353a027d350ea54e5d735607",
  • "data": {
    },
  • "timestamp": 1713175319903
}

Get all measure accounting effects

Get all measure accounting effects of the authenticated hub.

SecurityJWT
Request
query Parameters
measure
string or integer

The measure for which the measure budgeting effects should be displayed.

accounting_ledger_qualifier
string

The accounting ledger qualifier for which the measure budgeting effects should be displayed.

accounting_legal_entity_qualifier
string

The accounting legal entity qualifier for which the measure budgeting effects should be displayed.

budgeting_period
string

The budgeting period name for which the measure budgeting effects should be displayed.

start_time
string <date-time>

Filter the measure budgeting effects for a budgeting period start time.

The date must be before or equal to the end time.

end_time
string <date-time>

Filter the measure budgeting effects for a budgeting period end time.

The date must be after or equal to the start time.

calculated
boolean

Filter the measure budgeting effects for calculated effects.

filled
boolean

Filter the measure budgeting effects for filled effects.

locked
boolean

Filter the measure budgeting effects for locked effects.

created_user
string or integer

Filter the measure budgeting effects for a created user.

modified_user
string or integer

Filter the measure budgeting effects for a modified user.

page
integer
Default: 1

The page number of the response.

Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

get/measureaccountingeffect
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "12dbd78cd65178eebd14f91c25b4cf2753cb84b0",
  • "data": [
    ],
  • "meta": {
    },
  • "timestamp": 1713176389110
}