Sign in

v1

latestOpenAPI 3.1.02026-08-065163115.0 KB
Budget Topups

Create budget topup

Increase or decrease the available amount of a budget. Only permitted when has_member_limits is false for the budget.

post/v1/businesses/{client_id}/budgets/{budget_id}/topups

Path parameters

client_idinteger required
Example:123

The ID of the business.

budget_idstring required

The ID of the budget.

Request body

amountnumber required

Positive values increase the available amount, negative values decrease it.

descriptionstring required

The description of the topup.

auto_approveboolean

By default, topups require approval before being added to the budget. Set this to true to automatically add the topup to the budget.

Example request

{
  "amount": 100,
  "description": "Additional funds for travel",
  "auto_approve": true
}

Response

OK

idstring

The ID of the topup.

amountnumber

Positive values increase the available amount, negative values decrease it.

descriptionstring

The description of the topup.

status'APPROVED' | 'CANCELLED' | 'DECLINED' | 'PENDING'

The status of the topup.

actioned_onstring date-time

The date and time when the topup was actioned in UTC.

createdstring date-time

The date and time when the topup was created in UTC.

updatedstring date-time

The date and time when the topup was last updated in UTC.

Example response

{
  "id": "e33b7c61-5124-4ba0-b238-e4c573133715",
  "amount": 100,
  "description": "Additional funds for travel",
  "status": "APPROVED",
  "requested_by": {
    "id": 123,
    "first_name": "John",
    "last_name": "Doe",
    "name": "John Doe"
  },
  "actioned_by": {
    "id": 123,
    "first_name": "John",
    "last_name": "Doe",
    "name": "John Doe"
  },
  "actioned_on": "2024-01-01T00:00:00Z",
  "created": "2024-01-01T00:00:00Z",
  "updated": "2024-01-01T00:00:00Z"
}