post https://api.personetics.com/pserver/execute
Budgets array:
| Parameter Name | Type | Description |
|---|---|---|
| budgetSubject | string | The key that will be used to aggregate the data (categoryGroup code(s)/ subCategory code/merchant name/…) |
| budgetKey | string | The key that will be used to aggregate the data (categoryGroup code). This parameter should be returned in getBudgetsCategories only for singleCategory budgets. |
| budgetKeyDisplayName | string | When the budget type is “singleCategory”, return the spending category name according to the request language and configuration in SCategoryGroups.json. When budget type is NOT “singleCategory” return the same value returned in budgetNickname |
| isBudgeted | Boolean | This parameter points out if the user ever set up a budget for this category (true) or they never did (false) |
| budgetAvgMonthlySpending | number | The average monthly spending as calculated in the profiling batch |
| budgetStdevMonthlySpending | number | The STDEV from monthly average spending as calculated in the profiling batch |
| budgetRecommendedAmount | number | The recommended budget amount when the budget was set up |
| budgetId | string | UUID generated in the budget setup |
| budgetAmount | number | The selected amount that the user sets on the last change |
| budgetActivation | Boolean | Budget activation status. By default the parameter will be with the value “true”. If budget was deactivated the value will be “false”. |
| budgetLevel | string | Party (next phases - the budget cycle can be on a party or account) |
| budgetCycle | string | Monthly (next phases - the budget cycle can be on a monthly or weekly basis) |
| budgetType | string | • “singleCategory”- only one spending category. • “multicategory”- multiple spending categories are budgeted, according to user’s preferences and project configuration. (next phases – budget can be on singleCateogry, multiCategory, subCategory or merchant) |
| budgetNickname | string | User’s budget nickname if given |