Download OpenAPI specification:Download
The budgets API lets you manage your Brex budgets.
Lists Budgets belonging to this account
listBudgets 200 response
Bad request
Unauthorized
Forbidden
{- "next_cursor": "string",
- "items": [
- {
- "budget_id": "string",
- "account_id": "string",
- "creator_user_id": "string",
- "name": "string",
- "description": "string",
- "parent_budget_id": "string",
- "owner_user_ids": [
- "string"
], - "member_user_ids": [
- "string"
], - "period_type": "WEEKLY",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "limit": {
- "amount": 0,
- "currency": "string"
}, - "budget_status": "APPROVED",
- "limit_type": "HARD",
- "spend_type": "BUDGET_PROVISIONED_CARDS_ONLY",
- "current_period_balance": {
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "balance": {
- "amount": 0,
- "currency": "string"
}
}
}
]
}
Creates a Budget. This endpoint requires budget management. If your account does not have access to budget management features, a 403 response status will be returned. If this is the case and you want to gain access to this endpoint, please contact Brex support.
createBudget 200 response
Bad request
Unauthorized
Forbidden
{- "name": "string",
- "description": "string",
- "parent_budget_id": "string",
- "owner_user_ids": [
- "string"
], - "member_user_ids": [
- "string"
], - "period_type": "WEEKLY",
- "limit": {
- "amount": 0,
- "currency": "string"
}, - "limit_type": "HARD",
- "spend_type": "BUDGET_PROVISIONED_CARDS_ONLY",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "limit_visibility": "SHARED"
}
{- "budget_id": "string",
- "account_id": "string",
- "creator_user_id": "string",
- "name": "string",
- "description": "string",
- "parent_budget_id": "string",
- "owner_user_ids": [
- "string"
], - "member_user_ids": [
- "string"
], - "period_type": "WEEKLY",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "limit": {
- "amount": 0,
- "currency": "string"
}, - "budget_status": "APPROVED",
- "limit_type": "HARD",
- "spend_type": "BUDGET_PROVISIONED_CARDS_ONLY",
- "current_period_balance": {
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "balance": {
- "amount": 0,
- "currency": "string"
}
}
}
Retrieves a Budget by ID
getBudgetById 200 response
Bad request
Unauthorized
Forbidden
Not Found
{- "budget_id": "string",
- "account_id": "string",
- "creator_user_id": "string",
- "name": "string",
- "description": "string",
- "parent_budget_id": "string",
- "owner_user_ids": [
- "string"
], - "member_user_ids": [
- "string"
], - "period_type": "WEEKLY",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "limit": {
- "amount": 0,
- "currency": "string"
}, - "budget_status": "APPROVED",
- "limit_type": "HARD",
- "spend_type": "BUDGET_PROVISIONED_CARDS_ONLY",
- "current_period_balance": {
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "balance": {
- "amount": 0,
- "currency": "string"
}
}
}
Updates a Budget. This endpoint requires budget management. If your account does not have access to budget management features, a 403 response status will be returned. If this is the case and you want to gain access to this endpoint, please contact Brex support.
updateBudget 200 response
Bad request
Unauthorized
Forbidden
Not Found
{- "name": "string",
- "description": "string",
- "owner_user_ids": [
- "string"
], - "member_user_ids": [
- "string"
], - "limit": {
- "amount": 0,
- "currency": "string"
}, - "limit_type": "HARD",
- "spend_type": "BUDGET_PROVISIONED_CARDS_ONLY",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "limit_visibility": "SHARED"
}
{- "budget_id": "string",
- "account_id": "string",
- "creator_user_id": "string",
- "name": "string",
- "description": "string",
- "parent_budget_id": "string",
- "owner_user_ids": [
- "string"
], - "member_user_ids": [
- "string"
], - "period_type": "WEEKLY",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "limit": {
- "amount": 0,
- "currency": "string"
}, - "budget_status": "APPROVED",
- "limit_type": "HARD",
- "spend_type": "BUDGET_PROVISIONED_CARDS_ONLY",
- "current_period_balance": {
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "balance": {
- "amount": 0,
- "currency": "string"
}
}
}
Lists Budget Programs belonging to this account
listBudgetPrograms 200 response
Bad request
Unauthorized
Forbidden
{- "next_cursor": "string",
- "items": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "budget_blueprints": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "parent_budget_id": "string",
- "owner_user_ids": [
- "string"
], - "period_type": "WEEKLY",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "limit": {
- "amount": 0,
- "currency": "string"
}, - "limit_type": "HARD",
- "spend_type": "BUDGET_PROVISIONED_CARDS_ONLY"
}
], - "existing_budget_ids": [
- "string"
], - "employee_filter": {
- "employment_status": "EMPLOYMENT_STATUS_ACTIVE",
- "employment_type": "EMPLOYMENT_TYPE_FULL_TIME"
}, - "budget_program_status": "BUDGET_PROGRAM_STATUS_ACTIVE",
- "creator_user_id": "string",
- "created_at": "2019-08-24",
- "updated_at": "2019-08-24"
}
]
}
Creates a Budget Program. This endpoint requires budget management. If your account does not have access to budget management features, a 403 response status will be returned. If this is the case and you want to gain access to this endpoint, please contact Brex support.
createBudgetProgram 200 response
Bad request
Unauthorized
Forbidden
{- "existing_budget_ids": [
- "string"
], - "budget_blueprints": [
- {
- "name": "string",
- "description": "string",
- "parent_budget_id": "string",
- "owner_user_ids": [
- "string"
], - "period_type": "WEEKLY",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "limit": {
- "amount": 0,
- "currency": "string"
}, - "limit_type": "HARD",
- "spend_type": "BUDGET_PROVISIONED_CARDS_ONLY",
- "limit_visibility": "SHARED"
}
], - "employee_filter": {
- "employment_status": "EMPLOYMENT_STATUS_ACTIVE",
- "employment_type": "EMPLOYMENT_TYPE_FULL_TIME"
}, - "name": "string",
- "description": "string"
}
{- "id": "string",
- "name": "string",
- "description": "string",
- "budget_blueprints": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "parent_budget_id": "string",
- "owner_user_ids": [
- "string"
], - "period_type": "WEEKLY",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "limit": {
- "amount": 0,
- "currency": "string"
}, - "limit_type": "HARD",
- "spend_type": "BUDGET_PROVISIONED_CARDS_ONLY"
}
], - "existing_budget_ids": [
- "string"
], - "employee_filter": {
- "employment_status": "EMPLOYMENT_STATUS_ACTIVE",
- "employment_type": "EMPLOYMENT_TYPE_FULL_TIME"
}, - "budget_program_status": "BUDGET_PROGRAM_STATUS_ACTIVE",
- "creator_user_id": "string",
- "created_at": "2019-08-24",
- "updated_at": "2019-08-24"
}
Retrieves a Budget Program by ID
getBudgetProgramById 200 response
Bad request
Unauthorized
Forbidden
Not Found
{- "id": "string",
- "name": "string",
- "description": "string",
- "budget_blueprints": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "parent_budget_id": "string",
- "owner_user_ids": [
- "string"
], - "period_type": "WEEKLY",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "limit": {
- "amount": 0,
- "currency": "string"
}, - "limit_type": "HARD",
- "spend_type": "BUDGET_PROVISIONED_CARDS_ONLY"
}
], - "existing_budget_ids": [
- "string"
], - "employee_filter": {
- "employment_status": "EMPLOYMENT_STATUS_ACTIVE",
- "employment_type": "EMPLOYMENT_TYPE_FULL_TIME"
}, - "budget_program_status": "BUDGET_PROGRAM_STATUS_ACTIVE",
- "creator_user_id": "string",
- "created_at": "2019-08-24",
- "updated_at": "2019-08-24"
}
Updates a Budget Program. This endpoint requires budget management. If your account does not have access to budget management features, a 403 response status will be returned. If this is the case and you want to gain access to this endpoint, please contact Brex support.
updateBudgetProgram 200 response
Bad request
Unauthorized
Forbidden
Not Found
{- "existing_budget_ids": [
- "string"
], - "budget_blueprints": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "parent_budget_id": "string",
- "owner_user_ids": [
- "string"
], - "period_type": "WEEKLY",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "limit": {
- "amount": 0,
- "currency": "string"
}, - "limit_type": "HARD",
- "spend_type": "BUDGET_PROVISIONED_CARDS_ONLY"
}
], - "employee_filter": {
- "employment_status": "EMPLOYMENT_STATUS_ACTIVE",
- "employment_type": "EMPLOYMENT_TYPE_FULL_TIME"
}, - "name": "string",
- "description": "string"
}
{- "id": "string",
- "name": "string",
- "description": "string",
- "budget_blueprints": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "parent_budget_id": "string",
- "owner_user_ids": [
- "string"
], - "period_type": "WEEKLY",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "limit": {
- "amount": 0,
- "currency": "string"
}, - "limit_type": "HARD",
- "spend_type": "BUDGET_PROVISIONED_CARDS_ONLY"
}
], - "existing_budget_ids": [
- "string"
], - "employee_filter": {
- "employment_status": "EMPLOYMENT_STATUS_ACTIVE",
- "employment_type": "EMPLOYMENT_TYPE_FULL_TIME"
}, - "budget_program_status": "BUDGET_PROGRAM_STATUS_ACTIVE",
- "creator_user_id": "string",
- "created_at": "2019-08-24",
- "updated_at": "2019-08-24"
}
Delete a Budget Program by ID. This endpoint requires budget management. If your account does not have access to budget management features, a 403 response status will be returned. If this is the case and you want to gain access to this endpoint, please contact Brex support.
deleteBudgetProgram 200 response
Bad request
Unauthorized
Forbidden
Not Found
{- "id": "string",
- "name": "string",
- "description": "string",
- "budget_blueprints": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "parent_budget_id": "string",
- "owner_user_ids": [
- "string"
], - "period_type": "WEEKLY",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "limit": {
- "amount": 0,
- "currency": "string"
}, - "limit_type": "HARD",
- "spend_type": "BUDGET_PROVISIONED_CARDS_ONLY"
}
], - "existing_budget_ids": [
- "string"
], - "employee_filter": {
- "employment_status": "EMPLOYMENT_STATUS_ACTIVE",
- "employment_type": "EMPLOYMENT_TYPE_FULL_TIME"
}, - "budget_program_status": "BUDGET_PROGRAM_STATUS_ACTIVE",
- "creator_user_id": "string",
- "created_at": "2019-08-24",
- "updated_at": "2019-08-24"
}