About this endpoint
What it does
Calculates a monthly budget from the submitted income and expense list, then returns the result of the operation as a JSON object. The request body must include income and expenses.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| income | Number | Yes | Monthly income amount. |
| expenses | Object Array | Yes | List of expense items. Each item must include name and amount. |
| expenses[].kind | ENUM | No | 50/30/20 bucket for the expense item. Allowed values: need, want, savings, debt. |
| expenses[].name | String | Yes | Expense name. |
| expenses[].amount | Number | Yes | Expense amount. |
| expenses[].period | ENUM | No | Expense period. Allowed values: month, year. Default: month. A yearly amount is treated as amount / 12 per month. |
Response
Returns a JSON object. The output schema is an object with no defined properties, so the detailed response shape is not yet captured in the schema.



