Skip to content

Brex: Fields schemas

24 Brex schemas with complete fields and constraints.

← Fields operations · All schemas

Create a custom field — request body — body

FieldTypePresenceDescription and constraints
$objectRootRepresents the data needed to create a field. To create a field in the `ERP` group you must first set up an Accounting Integration and supply its `integration_id`.
groupJSONRequired within parent
group (allOf 1)ModelAll variants applyExpand Create a custom field — request body — body group string
group (allOf 2)JSONAll variants applyThe category of the field, indicating its purpose or context. For example, it could belong to accounting-related fields or user-related fields.
integration_idJSONOptional
integration_id (anyOf 1)stringAlternativeThe ID of the Accounting Integration to associate this field with. This property is **required** when `group` is `ERP`: it must reference an existing Accounting Integration, and requests that omit it or send `null` for an `ERP` field are rejected. For all other groups (`ACCOUNTING`, `USER`, `TRAVEL`) `integration_id` is not applicable and should be left null.
integration_id (anyOf 2)nullAlternative
is_disabledJSONOptional
is_disabled (anyOf 1)booleanAlternativeIndicates whether the field is disabled. A disabled field is not selectable: it is no longer offered as an option in the Brex dropdown and cannot be applied to new transactions. Records that already reference the field are unaffected.
is_disabled (anyOf 2)nullAlternative
namestringRequired within parentThe name of the field
remote_idJSONOptional
remote_id (anyOf 1)stringAlternativeRemote/external ID of custom field from external system (e.g. ERP or HRIS system)
remote_id (anyOf 2)nullAlternative

Referenced models: Create a custom field — request body — body group string

Create a custom field — request body — body group string

FieldTypePresenceDescription and constraints
$stringRootThe category of the field, indicating its purpose or context. Supported groups are:

* `ACCOUNTING` — Fields used to categorize transactions for accounting purposes (for example, expense categories or cost centers) that are managed directly within Brex.

* `USER` — Fields associated with users, used to capture user-specific attributes.

* `ERP` — Fields that are synced with an external ERP/accounting system through an Accounting Integration. Creating an Accounting Integration is a prerequisite for creating fields in the `ERP` group, and each `ERP` field must reference that integration through `integration_id`.

* `TRAVEL` — Fields used in the context of travel bookings and expenses.
One of: ACCOUNTING, USER, ERP, TRAVEL

Create custom field values — request body — body

FieldTypePresenceDescription and constraints
$objectRootRepresents the data needed to create multiple field values. It can't contain more than 1000 values at once.
itemsarrayRequired within parentThe list of field values to be created
Minimum items: 1
items[]ModelEach itemExpand Create custom field values — request body — body items item

Referenced models: Create custom field values — request body — body items item

Create custom field values — request body — body items item

FieldTypePresenceDescription and constraints
$objectRootRepresents the data needed to create a field value
is_disabledJSONOptional
is_disabled (anyOf 1)booleanAlternativeIndicates whether the field value is disabled. A disabled value is not selectable: it no longer appears as a selectable option in the dropdown and cannot be chosen on new transactions. Records that already use the value are unaffected.
is_disabled (anyOf 2)nullAlternative
remote_idJSONOptional
remote_id (anyOf 1)stringAlternativeRemote/external ID of custom field value from external system (e.g. ERP or HRIS system)
remote_id (anyOf 2)nullAlternative
valuestringRequired within parentThe display name of the field value
value_idJSONOptional
value_id (anyOf 1)stringAlternativeThe value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system
value_id (anyOf 2)nullAlternative

Create custom field values — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents a list of field values definition
itemsarrayRequired within parentThe list of created field values
items[]ModelEach itemExpand Get a field value — response body

Referenced models: Get a field value — response body

Delete custom field values — request body — body

FieldTypePresenceDescription and constraints
$objectRootRepresents the data needed to delete field values. It can't contain more than 1000 values at once.
itemsarrayRequired within parentMaximum items: 1000
Minimum items: 1
items[]ModelEach itemExpand Delete custom field values — request body — body items item

Referenced models: Delete custom field values — request body — body items item

Delete custom field values — request body — body items item

FieldTypePresenceDescription and constraints
$objectRootRepresents the data needed to delete a field value.
$ (oneOf 1)ModelAlternativeExpand Delete custom field values — request body — body items item by `brex id`
$ (oneOf 2)ModelAlternativeExpand Delete custom field values — request body — body items item by `value id`
$ (oneOf 3)ModelAlternativeExpand Delete custom field values — request body — body items item by `remote id`

Referenced models: Delete custom field values — request body — body items item by `brex id`, Delete custom field values — request body — body items item by `remote id`, Delete custom field values — request body — body items item by `value id`

Delete custom field values — request body — body items item by `brex id`

FieldTypePresenceDescription and constraints
$objectRootRepresents the data needed to delete a field value using its `brex_id`.
brex_idstringRequired within parentThe internal Brex ID of the field value

Delete custom field values — request body — body items item by `remote id`

FieldTypePresenceDescription and constraints
$objectRootRepresents the data needed to delete a field value using its `remote_id`.
remote_idstringRequired within parentRemote/external ID of custom field value from external system (e.g. ERP or HRIS system)

Delete custom field values — request body — body items item by `value id`

FieldTypePresenceDescription and constraints
$objectRootRepresents the data needed to delete a field value using its `value_id`.
value_idstringRequired within parentThe value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system

Delete custom field values — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents the confirmation of number of deleted field values

Get a field value — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents a field value definition
brex_idstringRequired within parentThe internal Brex ID of the field value
field_idstringRequired within parentThe ID of the parent field this value belongs to
is_disabledbooleanRequired within parentIndicates whether the field value is disabled. A disabled value is not selectable: it no longer appears as a selectable option in the dropdown and cannot be chosen on new transactions. Records that already use the value are unaffected.
remote_idJSONOptional
remote_id (anyOf 1)stringAlternativeRemote/external ID of custom field value from external system (e.g. ERP or HRIS system)
remote_id (anyOf 2)nullAlternative
updated_atstringRequired within parentThe last updated timestamp of the field value
Format: date-time
valuestringRequired within parentThe display name of the field value
value_idJSONOptional
value_id (anyOf 1)stringAlternativeThe value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system
value_id (anyOf 2)nullAlternative

Get custom field — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents a field definition
brex_idstringRequired within parentThe internal Brex ID of the field
groupJSONOptional
group (anyOf 1)JSONAlternative
group (anyOf 1) (allOf 1)ModelAll variants applyExpand Get custom field — response body — group string string
group (anyOf 1) (allOf 2)JSONAll variants applyThe category of the field, indicating its purpose or context. For example, it could belong to accounting-related fields or user-related fields.
group (anyOf 2)nullAlternative
is_disabledbooleanRequired within parentIndicates whether the field is disabled. A disabled field is not selectable: it is no longer offered as an option in the Brex dropdown and cannot be applied to new transactions. Records that already reference the field are unaffected.
nameJSONRequired within parent
name (anyOf 1)stringAlternativeThe name of the field
name (anyOf 2)nullAlternative
remote_idJSONOptional
remote_id (anyOf 1)stringAlternativeRemote/external ID of custom field from external system (e.g. ERP or HRIS system)
remote_id (anyOf 2)nullAlternative
updated_atstringRequired within parentThe last updated timestamp of the field
Format: date-time

Referenced models: Get custom field — response body — group string string

Get custom field — response body — group string string

FieldTypePresenceDescription and constraints
$stringRootThe category of the field, indicating its purpose or context. Supported groups are:

* `ACCOUNTING` — Fields used to categorize transactions for accounting purposes (for example, expense categories or cost centers) that are managed directly within Brex.

* `USER` — Fields associated with users, used to capture user-specific attributes.

* `ERP` — Fields that are synced with an external ERP/accounting system through an Accounting Integration. Creating an Accounting Integration is a prerequisite for creating fields in the `ERP` group, and each `ERP` field must reference that integration through `integration_id`.

* `TRAVEL` — Fields used in the context of travel bookings and expenses.
Known values: ACCOUNTING, USER, ERP, TRAVEL

List custom field values — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Get a field value — response body
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Get a field value — response body

List custom fields — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Get custom field — response body
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Get custom field — response body

Update a custom field — request body — body

FieldTypePresenceDescription and constraints
$objectRootRepresents the data needed to update a field
is_disabledJSONOptional
is_disabled (anyOf 1)booleanAlternativeIndicates whether the field is disabled. A disabled field is not selectable: it is no longer offered as an option in the Brex dropdown and cannot be applied to new transactions. Records that already reference the field are unaffected.
is_disabled (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeThe name of the field
name (anyOf 2)nullAlternative

Update custom field values — request body — body

FieldTypePresenceDescription and constraints
$objectRootRepresents the data needed to update multiple field values. It can't contain more than 1000 values at once.
itemsarrayRequired within parentMaximum items: 1000
Minimum items: 1
items[]ModelEach itemExpand Update custom field values — request body — body items item

Referenced models: Update custom field values — request body — body items item

Update custom field values — request body — body items item

FieldTypePresenceDescription and constraints
$objectRootRepresents the data needed to update a field value.
$ (oneOf 1)ModelAlternativeExpand Update custom field values — request body — body items item by `brex id`
$ (oneOf 2)ModelAlternativeExpand Update custom field values — request body — body items item by `value id`
$ (oneOf 3)ModelAlternativeExpand Update custom field values — request body — body items item by `remote id`

Referenced models: Update custom field values — request body — body items item by `brex id`, Update custom field values — request body — body items item by `remote id`, Update custom field values — request body — body items item by `value id`

Update custom field values — request body — body items item by `brex id`

FieldTypePresenceDescription and constraints
$objectRootRepresents the data needed to update a field value using its `brex_id`.
brex_idstringRequired within parentThe internal Brex ID of the field value
dataJSONRequired within parent
data (allOf 1)ModelAll variants applyExpand Update custom field values — request body — body items item by `brex id` data Field value update data
data (allOf 2)JSONAll variants applyField value data to update

Referenced models: Update custom field values — request body — body items item by `brex id` data Field value update data

Update custom field values — request body — body items item by `brex id` data Field value update data

FieldTypePresenceDescription and constraints
$objectRootRepresents the updated data of a field value
is_disabledJSONOptional
is_disabled (anyOf 1)booleanAlternativeIndicates whether the field value is disabled. A disabled value is not selectable: it no longer appears as a selectable option in the dropdown and cannot be chosen on new transactions. Records that already use the value are unaffected.
is_disabled (anyOf 2)nullAlternative
valueJSONOptional
value (anyOf 1)stringAlternativeThe display name of the field value
value (anyOf 2)nullAlternative

Update custom field values — request body — body items item by `remote id`

FieldTypePresenceDescription and constraints
$objectRootRepresents the data needed to update a field value using its `remote_id`.
dataJSONRequired within parent
data (allOf 1)ModelAll variants applyExpand Update custom field values — request body — body items item by `brex id` data Field value update data
data (allOf 2)JSONAll variants applyField value data to update
remote_idstringRequired within parentRemote/external ID of custom field value from external system (e.g. ERP or HRIS system)

Referenced models: Update custom field values — request body — body items item by `brex id` data Field value update data

Update custom field values — request body — body items item by `value id`

FieldTypePresenceDescription and constraints
$objectRootRepresents the data needed to update a field value using its `value_id`.
dataJSONRequired within parent
data (allOf 1)ModelAll variants applyExpand Update custom field values — request body — body items item by `brex id` data Field value update data
data (allOf 2)JSONAll variants applyField value data to update
value_idstringRequired within parentThe value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system

Referenced models: Update custom field values — request body — body items item by `brex id` data Field value update data

Update custom field values — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents a list of updated field values
itemsarrayRequired within parentThe list of updated field values
items[]ModelEach itemExpand Get a field value — response body

Referenced models: Get a field value — response body

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.