Brex: Fields schemas
24 Brex schemas with complete fields and constraints.
← Fields operations · All schemas
Create a custom field — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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`. |
group | JSON | Required within parent | |
group (allOf 1) | Model | All variants apply | Expand Create a custom field — request body — body group string |
group (allOf 2) | JSON | All variants apply | The category of the field, indicating its purpose or context. For example, it could belong to accounting-related fields or user-related fields. |
integration_id | JSON | Optional | |
integration_id (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
is_disabled | JSON | Optional | |
is_disabled (anyOf 1) | boolean | Alternative | Indicates 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) | null | Alternative | |
name | string | Required within parent | The name of the field |
remote_id | JSON | Optional | |
remote_id (anyOf 1) | string | Alternative | Remote/external ID of custom field from external system (e.g. ERP or HRIS system) |
remote_id (anyOf 2) | null | Alternative |
Referenced models: Create a custom field — request body — body group string
Create a custom field — request body — body group string
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data needed to create multiple field values. It can't contain more than 1000 values at once. |
items | array | Required within parent | The list of field values to be created Minimum items: 1 |
items[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data needed to create a field value |
is_disabled | JSON | Optional | |
is_disabled (anyOf 1) | boolean | Alternative | Indicates 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) | null | Alternative | |
remote_id | JSON | Optional | |
remote_id (anyOf 1) | string | Alternative | Remote/external ID of custom field value from external system (e.g. ERP or HRIS system) |
remote_id (anyOf 2) | null | Alternative | |
value | string | Required within parent | The display name of the field value |
value_id | JSON | Optional | |
value_id (anyOf 1) | string | Alternative | The 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) | null | Alternative |
Create custom field values — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a list of field values definition |
items | array | Required within parent | The list of created field values |
items[] | Model | Each item | Expand Get a field value — response body |
Referenced models: Get a field value — response body
Delete custom field values — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data needed to delete field values. It can't contain more than 1000 values at once. |
items | array | Required within parent | Maximum items: 1000 Minimum items: 1 |
items[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data needed to delete a field value. |
$ (oneOf 1) | Model | Alternative | Expand Delete custom field values — request body — body items item by `brex id` |
$ (oneOf 2) | Model | Alternative | Expand Delete custom field values — request body — body items item by `value id` |
$ (oneOf 3) | Model | Alternative | Expand 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`
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data needed to delete a field value using its `brex_id`. |
brex_id | string | Required within parent | The internal Brex ID of the field value |
Delete custom field values — request body — body items item by `remote id`
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data needed to delete a field value using its `remote_id`. |
remote_id | string | Required within parent | Remote/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`
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data needed to delete a field value using its `value_id`. |
value_id | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the confirmation of number of deleted field values |
Get a field value — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a field value definition |
brex_id | string | Required within parent | The internal Brex ID of the field value |
field_id | string | Required within parent | The ID of the parent field this value belongs to |
is_disabled | boolean | Required within parent | Indicates 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_id | JSON | Optional | |
remote_id (anyOf 1) | string | Alternative | Remote/external ID of custom field value from external system (e.g. ERP or HRIS system) |
remote_id (anyOf 2) | null | Alternative | |
updated_at | string | Required within parent | The last updated timestamp of the field value Format: date-time |
value | string | Required within parent | The display name of the field value |
value_id | JSON | Optional | |
value_id (anyOf 1) | string | Alternative | The 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) | null | Alternative |
Get custom field — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a field definition |
brex_id | string | Required within parent | The internal Brex ID of the field |
group | JSON | Optional | |
group (anyOf 1) | JSON | Alternative | |
group (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get custom field — response body — group string string |
group (anyOf 1) (allOf 2) | JSON | All variants apply | The 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) | null | Alternative | |
is_disabled | boolean | Required within parent | Indicates 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. |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | The name of the field |
name (anyOf 2) | null | Alternative | |
remote_id | JSON | Optional | |
remote_id (anyOf 1) | string | Alternative | Remote/external ID of custom field from external system (e.g. ERP or HRIS system) |
remote_id (anyOf 2) | null | Alternative | |
updated_at | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get a field value — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get a field value — response body
List custom fields — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get custom field — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get custom field — response body
Update a custom field — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data needed to update a field |
is_disabled | JSON | Optional | |
is_disabled (anyOf 1) | boolean | Alternative | Indicates 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) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the field |
name (anyOf 2) | null | Alternative |
Update custom field values — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data needed to update multiple field values. It can't contain more than 1000 values at once. |
items | array | Required within parent | Maximum items: 1000 Minimum items: 1 |
items[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data needed to update a field value. |
$ (oneOf 1) | Model | Alternative | Expand Update custom field values — request body — body items item by `brex id` |
$ (oneOf 2) | Model | Alternative | Expand Update custom field values — request body — body items item by `value id` |
$ (oneOf 3) | Model | Alternative | Expand 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`
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data needed to update a field value using its `brex_id`. |
brex_id | string | Required within parent | The internal Brex ID of the field value |
data | JSON | Required within parent | |
data (allOf 1) | Model | All variants apply | Expand Update custom field values — request body — body items item by `brex id` data Field value update data |
data (allOf 2) | JSON | All variants apply | Field 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the updated data of a field value |
is_disabled | JSON | Optional | |
is_disabled (anyOf 1) | boolean | Alternative | Indicates 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) | null | Alternative | |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | The display name of the field value |
value (anyOf 2) | null | Alternative |
Update custom field values — request body — body items item by `remote id`
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data needed to update a field value using its `remote_id`. |
data | JSON | Required within parent | |
data (allOf 1) | Model | All variants apply | Expand Update custom field values — request body — body items item by `brex id` data Field value update data |
data (allOf 2) | JSON | All variants apply | Field value data to update |
remote_id | string | Required within parent | Remote/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`
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data needed to update a field value using its `value_id`. |
data | JSON | Required within parent | |
data (allOf 1) | Model | All variants apply | Expand Update custom field values — request body — body items item by `brex id` data Field value update data |
data (allOf 2) | JSON | All variants apply | Field value data to update |
value_id | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a list of updated field values |
items | array | Required within parent | The list of updated field values |
items[] | Model | Each item | Expand Get a field value — response body |
Referenced models: Get a field value — response body