BRbrex-com
Fields

Create a custom field

Create a custom field

post/v1/fields

Request

  • Base URL
    https://api.brex.com
  • Auth
    OAuth 2
    Authorization codehttps://accounts-api.brex.com/oauth2/default/v1/authorize
    Token URLhttps://accounts-api.brex.com/oauth2/default/v1/token
    Scopesfields.write
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Headers

Idempotency-Keystring required

Idempotency key for this request.

Request body

namestring required

The name of the field

group'ACCOUNTING' | 'USER' | 'ERP' | 'TRAVEL' required

The category of the field, indicating its purpose or context. For example, it could belong to accounting-related fields or user-related fields.

remote_idstring nullable

Remote/external ID of custom field from external system (e.g. ERP or HRIS system)

integration_idstring nullable

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.

is_disabledboolean nullable

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.

Example request

{
  "remote_id": "foo_bar",
  "integration_id": "int_123"
}

Response

Create custom field response

brex_idstring required

The internal Brex ID of the field

namestring nullable required

The name of the field

remote_idstring nullable

Remote/external ID of custom field from external system (e.g. ERP or HRIS system)

updated_atstring date-time required

The last updated timestamp of the field

is_disabledboolean required

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.

group'ACCOUNTING' | 'USER' | 'ERP' | 'TRAVEL' nullable

The category of the field, indicating its purpose or context. For example, it could belong to accounting-related fields or user-related fields.

Example response

{
  "brex_id": "extended_field_foobar",
  "remote_id": "foo_bar"
}

Changes

No recorded changes to this operation across all 1 revision of this API.