API Reference

Ask for more funds or a new budget

post
https://api.cardda.com/v1/budget_requests

Creates a pending budget request and notifies whoever can approve it.

Who can ask

  • more_funds ("Más fondos"): someone in the budget (its Encargado, a co-encargado,
    or a participant, explicit or through a card) without budgets_manage. An admin
    / budgets_manage user gets budget_requests/use_top_up: they adjust the budget
    directly, with POST /v1/budgets/{id}/top_up for a funded budget or
    PATCH /v1/budgets/{id}/amount for a tracking one. GET /v1/budgets/{id} says whether
    the caller can ask (viewer.can.request_funds) and returns their pending request
    (own_pending_request).
  • new_budget ("Presupuesto nuevo"): any active member of the company.

Only one pending request per person and budget (more_funds) or per person and name
(new_budget): another one answers budget_requests/already_pending.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required
Allowed:
int64
required
≥ 1

What's asked for. Must be over 0 (budget_requests/invalid_amount).

string
required

Why it's needed. Required.

uuid
required

more_funds only, required: the budget that needs more funds.

string
enum

more_funds only. Required when the budget renews (recurrence_unit set), and
refused when it doesn't; a mismatch answers 422 with only message (unlike
approval, which answers budget_requests/invalid_period_scope):

  • current_period: for the period in progress.
  • next_periods: raise what each period starts with from the next renewal on.
Allowed:
string

new_budget only, required: name of the budget asked for.

string
enum

new_budget only: how often it should renew. Omit it for a budget that doesn't renew.

Allowed:
integer
≥ 1

new_budget only, with recurrence_unit: 1 to 52 weeks, 1 to 24 months or 1 to 5 years.

participant_ids
array of strings

new_budget only: users to add to the budget as participants.

participant_ids
Headers
uuid
required

UUID of the company on whose behalf the request is made. Required for every Finance endpoint.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

Responses

401

Unauthorized - missing or invalid authentication token, or a caller outside the company.

Updated about 8 hours ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 8 hours ago

Did this page help you?