apyhub
Back

Monthly Budget Planner API

What it does

Monthly Budget Planner helps you total a monthly budget from one income value and an expenses list. Send income and expenses, and it returns a structured response for budget calculations based on the amounts you provide.

Each expense item includes a name and amount, and can also include kind and period. Use kind to label items as need, want, savings, or debt. Use period when an expense is monthly or yearly; yearly amounts are treated as amount / 12 per month, which is useful for annual bills and sinking funds.

Use Monthly Budget Planner when you want to break down paychecks, compare spending categories, or estimate how much room is left after fixed bills and savings goals. It fits budgeting tools, personal finance workflows, and planning screens that need to turn a simple income and expense list into month-based totals.

The service is designed for direct calculation rather than advice: you give it the numbers, and it gives you the budget result you can use in your app or agent flow.

POST
Total a monthly budget and return spending, savings and remaining money
https://api.eu.apyhub.com/freedailypro/monthly-budget-planner/monthly-budget

QUICKSTART

GUIDE

Quickstart

Send your monthly income and expense list to generate a budget plan.

curl -X POST "https://api.eu.apyhub.com/freedailypro/monthly-budget-planner/monthly-budget" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "income": 5000,
    "expenses": [
      {
        "name": "Rent",
        "amount": 1800
      }
    ]
  }'

What you'll get back

Returns a JSON object. The output schema does not declare any top-level fields, so the response shape is not specified here.

{
  "result": {
    "income": 5000,
    "spent": 1800,
    "remaining": 3200,
    "savingsRatePct": 64,
    "expenses": [
      {
        "name": "Rent",
        "amount": 1800
      }
    ]
  }
TRY ITLIVE · 10 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*
expenses*

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

ParameterTypeMandatoryDescription
incomeNumberYesMonthly income amount.
expensesObject ArrayYesList of expense items. Each item must include name and amount.
expenses[].kindENUMNo50/30/20 bucket for the expense item. Allowed values: need, want, savings, debt.
expenses[].nameStringYesExpense name.
expenses[].amountNumberYesExpense amount.
expenses[].periodENUMNoExpense 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.

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.