Skip to content

Create budget topup

Request

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

Security
BearerAuth
Path
client_idintegerrequired

The ID of the business.

Example:123
budget_idstringrequired

The ID of the budget.

Bodyapplication/json
amountnumberrequired

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

Example:100
descriptionstringrequired

The description of the topup.

Example:"Additional funds for travel"
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:true
curl -i -X POST \
  'https://public.letsweel.com/v1/businesses/123/budgets/{budget_id}/topups' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 100,
    "description": "Additional funds for travel",
    "auto_approve": true
  }'

Responses

OK

Bodyapplication/json
idstring

The ID of the topup.

Example:"e33b7c61-5124-4ba0-b238-e4c573133715"
amountnumber

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

Example:100
descriptionstring

The description of the topup.

Example:"Additional funds for travel"
statusstring

The status of the topup.

Enum:"APPROVED""CANCELLED""DECLINED""PENDING"
Example:"APPROVED"
requested_byobject or null(SubUser)

The user who requested the topup.

actioned_byobject or null(SubUser)

The user who actioned an approval or decline of the topup.

actioned_onstring, (date-time)

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

Example:"2024-01-01T00:00:00Z"
createdstring, (date-time)

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

Example:"2024-01-01T00:00:00Z"
updatedstring, (date-time)

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

Example:"2024-01-01T00:00:00Z"
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"
}