FieldsComponents
Defined in: src/fields/types.gen.ts:109
Properties
Section titled “Properties”headers
Section titled “headers”headers:
never
Defined in: src/fields/types.gen.ts:386
parameters
Section titled “parameters”parameters:
never
Defined in: src/fields/types.gen.ts:384
pathItems
Section titled “pathItems”pathItems:
never
Defined in: src/fields/types.gen.ts:387
requestBodies
Section titled “requestBodies”requestBodies:
never
Defined in: src/fields/types.gen.ts:385
responses
Section titled “responses”responses:
never
Defined in: src/fields/types.gen.ts:383
schemas
Section titled “schemas”schemas:
object
Defined in: src/fields/types.gen.ts:110
CreateFieldValueBody
Section titled “CreateFieldValueBody”CreateFieldValueBody:
object
Field value creation
Description
Section titled “Description”Represents the data needed to create a field value
CreateFieldValueBody.is_disabled?
Section titled “CreateFieldValueBody.is_disabled?”
optionalis_disabled?:boolean|null
Description
Section titled “Description”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.
CreateFieldValueBody.remote_id?
Section titled “CreateFieldValueBody.remote_id?”
optionalremote_id?:string|null
Description
Section titled “Description”Remote/external ID of custom field value from external system (e.g. ERP or HRIS system)
Example
Section titled “Example”foo_barCreateFieldValueBody.value
Section titled “CreateFieldValueBody.value”value:
string
Description
Section titled “Description”The display name of the field value
CreateFieldValueBody.value_id?
Section titled “CreateFieldValueBody.value_id?”
optionalvalue_id?:string|null
Description
Section titled “Description”The value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system
Example
Section titled “Example”FooBarCreateFieldValueListBody
Section titled “CreateFieldValueListBody”CreateFieldValueListBody:
object
Field value list creation
Description
Section titled “Description”Represents the data needed to create multiple field values. It can’t contain more than 1000 values at once.
CreateFieldValueListBody.items
Section titled “CreateFieldValueListBody.items”items:
object[]
Description
Section titled “Description”The list of field values to be created
CreateFieldValueListResponse
Section titled “CreateFieldValueListResponse”CreateFieldValueListResponse:
object
Field value list
Description
Section titled “Description”Represents a list of field values definition
CreateFieldValueListResponse.items
Section titled “CreateFieldValueListResponse.items”items:
object[]
Description
Section titled “Description”The list of created field values
DeletedFieldValueListResponse
Section titled “DeletedFieldValueListResponse”DeletedFieldValueListResponse:
Record<string,never>
Field value deleted response
Description
Section titled “Description”Represents the confirmation of number of deleted field values
DeleteFieldValue.ByBrexId
Section titled “DeleteFieldValue.ByBrexId”DeleteFieldValue.ByBrexId:
object
by brex_id
Description
Section titled “Description”Represents the data needed to delete a field value using its brex_id.
DeleteFieldValue.ByBrexId.brex_id
Section titled “DeleteFieldValue.ByBrexId.brex_id”brex_id:
string
Description
Section titled “Description”The internal Brex ID of the field value
Example
Section titled “Example”efo_foobarDeleteFieldValue.ByRemoteId
Section titled “DeleteFieldValue.ByRemoteId”DeleteFieldValue.ByRemoteId:
object
by remote_id
Description
Section titled “Description”Represents the data needed to delete a field value using its remote_id.
DeleteFieldValue.ByRemoteId.remote_id
Section titled “DeleteFieldValue.ByRemoteId.remote_id”remote_id:
string
Description
Section titled “Description”Remote/external ID of custom field value from external system (e.g. ERP or HRIS system)
Example
Section titled “Example”foo_barDeleteFieldValue.ByValueId
Section titled “DeleteFieldValue.ByValueId”DeleteFieldValue.ByValueId:
object
by value_id
Description
Section titled “Description”Represents the data needed to delete a field value using its value_id.
DeleteFieldValue.ByValueId.value_id
Section titled “DeleteFieldValue.ByValueId.value_id”value_id:
string
Description
Section titled “Description”The value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system
Example
Section titled “Example”FooBarDeleteFieldValueBody
Section titled “DeleteFieldValueBody”DeleteFieldValueBody: {
brex_id:string; } | {remote_id:string; } | {value_id:string; }
Field value to delete
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ brex_id: string; }
brex_id
Section titled “brex_id”brex_id:
string
Description
Section titled “Description”The internal Brex ID of the field value
Example
Section titled “Example”efo_foobarType Literal
Section titled “Type Literal”{ remote_id: string; }
remote_id
Section titled “remote_id”remote_id:
string
Description
Section titled “Description”Remote/external ID of custom field value from external system (e.g. ERP or HRIS system)
Example
Section titled “Example”foo_barType Literal
Section titled “Type Literal”{ value_id: string; }
value_id
Section titled “value_id”value_id:
string
Description
Section titled “Description”The value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system
Example
Section titled “Example”FooBarDescription
Section titled “Description”Represents the data needed to delete a field value.
DeleteFieldValueListBody
Section titled “DeleteFieldValueListBody”DeleteFieldValueListBody:
object
Field value list deletion
Description
Section titled “Description”Represents the data needed to delete field values. It can’t contain more than 1000 values at once.
DeleteFieldValueListBody.items
Section titled “DeleteFieldValueListBody.items”items: ({
brex_id:string; } | {remote_id:string; } | {value_id:string; })[]
Field:
object
Field
Description
Section titled “Description”Represents a field definition
Field.brex_id
Section titled “Field.brex_id”brex_id:
string
Description
Section titled “Description”The internal Brex ID of the field
Example
Section titled “Example”extended_field_foobarField.group?
Section titled “Field.group?”
optionalgroup?:"TRAVEL"|"ACCOUNTING"|"USER"|"ERP"|null
Field.is_disabled
Section titled “Field.is_disabled”is_disabled:
boolean
Description
Section titled “Description”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.
Field.name
Section titled “Field.name”name:
string|null
Description
Section titled “Description”The name of the field
Field.remote_id?
Section titled “Field.remote_id?”
optionalremote_id?:string|null
Description
Section titled “Description”Remote/external ID of custom field from external system (e.g. ERP or HRIS system)
Example
Section titled “Example”foo_barField.updated_at
Section titled “Field.updated_at”updated_at:
string
Format: date-time
Description
Section titled “Description”The last updated timestamp of the field
FieldCreateBody
Section titled “FieldCreateBody”FieldCreateBody:
object
Field creation
Description
Section titled “Description”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.
FieldCreateBody.group
Section titled “FieldCreateBody.group”group:
"TRAVEL"|"ACCOUNTING"|"USER"|"ERP"
FieldCreateBody.integration_id?
Section titled “FieldCreateBody.integration_id?”
optionalintegration_id?:string|null
Description
Section titled “Description”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.
Example
Section titled “Example”int_123FieldCreateBody.is_disabled?
Section titled “FieldCreateBody.is_disabled?”
optionalis_disabled?:boolean|null
Description
Section titled “Description”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.
FieldCreateBody.name
Section titled “FieldCreateBody.name”name:
string
Description
Section titled “Description”The name of the field
FieldCreateBody.remote_id?
Section titled “FieldCreateBody.remote_id?”
optionalremote_id?:string|null
Description
Section titled “Description”Remote/external ID of custom field from external system (e.g. ERP or HRIS system)
Example
Section titled “Example”foo_barFieldGroup
Section titled “FieldGroup”FieldGroup:
"TRAVEL"|"ACCOUNTING"|"USER"|"ERP"
Description
Section titled “Description”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.FieldUpdateBody
Section titled “FieldUpdateBody”FieldUpdateBody:
object
Field update
Description
Section titled “Description”Represents the data needed to update a field
FieldUpdateBody.is_disabled?
Section titled “FieldUpdateBody.is_disabled?”
optionalis_disabled?:boolean|null
Description
Section titled “Description”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.
FieldUpdateBody.name?
Section titled “FieldUpdateBody.name?”
optionalname?:string|null
Description
Section titled “Description”The name of the field
FieldValue
Section titled “FieldValue”FieldValue:
object
Field value
Description
Section titled “Description”Represents a field value definition
FieldValue.brex_id
Section titled “FieldValue.brex_id”brex_id:
string
Description
Section titled “Description”The internal Brex ID of the field value
Example
Section titled “Example”efo_foobarFieldValue.field_id
Section titled “FieldValue.field_id”field_id:
string
Description
Section titled “Description”The ID of the parent field this value belongs to
Example
Section titled “Example”extended_field_foobarFieldValue.is_disabled
Section titled “FieldValue.is_disabled”is_disabled:
boolean
Description
Section titled “Description”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.
FieldValue.remote_id?
Section titled “FieldValue.remote_id?”
optionalremote_id?:string|null
Description
Section titled “Description”Remote/external ID of custom field value from external system (e.g. ERP or HRIS system)
Example
Section titled “Example”foo_barFieldValue.updated_at
Section titled “FieldValue.updated_at”updated_at:
string
Format: date-time
Description
Section titled “Description”The last updated timestamp of the field value
FieldValue.value
Section titled “FieldValue.value”value:
string
Description
Section titled “Description”The display name of the field value
FieldValue.value_id?
Section titled “FieldValue.value_id?”
optionalvalue_id?:string|null
Description
Section titled “Description”The value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system
Example
Section titled “Example”foo_barPage_Field_
Section titled “Page_Field_”Page_Field_:
object
Page_Field_.items
Section titled “Page_Field_.items”items:
object[]
Page_Field_.next_cursor?
Section titled “Page_Field_.next_cursor?”
optionalnext_cursor?:string|null
Page_FieldValue_
Section titled “Page_FieldValue_”Page_FieldValue_:
object
Page_FieldValue_.items
Section titled “Page_FieldValue_.items”items:
object[]
Page_FieldValue_.next_cursor?
Section titled “Page_FieldValue_.next_cursor?”
optionalnext_cursor?:string|null
UpdateFieldValue.ByBrexId
Section titled “UpdateFieldValue.ByBrexId”UpdateFieldValue.ByBrexId:
object
by brex_id
Description
Section titled “Description”Represents the data needed to update a field value using its brex_id.
UpdateFieldValue.ByBrexId.brex_id
Section titled “UpdateFieldValue.ByBrexId.brex_id”brex_id:
string
Description
Section titled “Description”The internal Brex ID of the field value
Example
Section titled “Example”efo_foobarUpdateFieldValue.ByBrexId.data
Section titled “UpdateFieldValue.ByBrexId.data”data:
object
UpdateFieldValue.ByBrexId.data.is_disabled?
Section titled “UpdateFieldValue.ByBrexId.data.is_disabled?”
optionalis_disabled?:boolean|null
Description
Section titled “Description”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.
UpdateFieldValue.ByBrexId.data.value?
Section titled “UpdateFieldValue.ByBrexId.data.value?”
optionalvalue?:string|null
Description
Section titled “Description”The display name of the field value
UpdateFieldValue.ByRemoteId
Section titled “UpdateFieldValue.ByRemoteId”UpdateFieldValue.ByRemoteId:
object
by remote_id
Description
Section titled “Description”Represents the data needed to update a field value using its remote_id.
UpdateFieldValue.ByRemoteId.data
Section titled “UpdateFieldValue.ByRemoteId.data”data:
object
UpdateFieldValue.ByRemoteId.data.is_disabled?
Section titled “UpdateFieldValue.ByRemoteId.data.is_disabled?”
optionalis_disabled?:boolean|null
Description
Section titled “Description”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.
UpdateFieldValue.ByRemoteId.data.value?
Section titled “UpdateFieldValue.ByRemoteId.data.value?”
optionalvalue?:string|null
Description
Section titled “Description”The display name of the field value
UpdateFieldValue.ByRemoteId.remote_id
Section titled “UpdateFieldValue.ByRemoteId.remote_id”remote_id:
string
Description
Section titled “Description”Remote/external ID of custom field value from external system (e.g. ERP or HRIS system)
Example
Section titled “Example”foo_barUpdateFieldValue.ByValueId
Section titled “UpdateFieldValue.ByValueId”UpdateFieldValue.ByValueId:
object
by value_id
Description
Section titled “Description”Represents the data needed to update a field value using its value_id.
UpdateFieldValue.ByValueId.data
Section titled “UpdateFieldValue.ByValueId.data”data:
object
UpdateFieldValue.ByValueId.data.is_disabled?
Section titled “UpdateFieldValue.ByValueId.data.is_disabled?”
optionalis_disabled?:boolean|null
Description
Section titled “Description”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.
UpdateFieldValue.ByValueId.data.value?
Section titled “UpdateFieldValue.ByValueId.data.value?”
optionalvalue?:string|null
Description
Section titled “Description”The display name of the field value
UpdateFieldValue.ByValueId.value_id
Section titled “UpdateFieldValue.ByValueId.value_id”value_id:
string
Description
Section titled “Description”The value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system
Example
Section titled “Example”FooBarUpdateFieldValueBody
Section titled “UpdateFieldValueBody”UpdateFieldValueBody: {
brex_id:string;data: {is_disabled?:boolean|null;value?:string|null; }; } | {data: {is_disabled?:boolean|null;value?:string|null; };remote_id:string; } | {data: {is_disabled?:boolean|null;value?:string|null; };value_id:string; }
Field value to update
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ brex_id: string; data: { is_disabled?: boolean | null; value?: string | null; }; }
brex_id
Section titled “brex_id”brex_id:
string
Description
Section titled “Description”The internal Brex ID of the field value
Example
Section titled “Example”efo_foobardata:
object
data.is_disabled?
Section titled “data.is_disabled?”
optionalis_disabled?:boolean|null
Description
Section titled “Description”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.
data.value?
Section titled “data.value?”
optionalvalue?:string|null
Description
Section titled “Description”The display name of the field value
Type Literal
Section titled “Type Literal”{ data: { is_disabled?: boolean | null; value?: string | null; }; remote_id: string; }
data:
object
data.is_disabled?
Section titled “data.is_disabled?”
optionalis_disabled?:boolean|null
Description
Section titled “Description”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.
data.value?
Section titled “data.value?”
optionalvalue?:string|null
Description
Section titled “Description”The display name of the field value
remote_id
Section titled “remote_id”remote_id:
string
Description
Section titled “Description”Remote/external ID of custom field value from external system (e.g. ERP or HRIS system)
Example
Section titled “Example”foo_barType Literal
Section titled “Type Literal”{ data: { is_disabled?: boolean | null; value?: string | null; }; value_id: string; }
data:
object
data.is_disabled?
Section titled “data.is_disabled?”
optionalis_disabled?:boolean|null
Description
Section titled “Description”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.
data.value?
Section titled “data.value?”
optionalvalue?:string|null
Description
Section titled “Description”The display name of the field value
value_id
Section titled “value_id”value_id:
string
Description
Section titled “Description”The value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system
Example
Section titled “Example”FooBarDescription
Section titled “Description”Represents the data needed to update a field value.
UpdateFieldValueDataBody
Section titled “UpdateFieldValueDataBody”UpdateFieldValueDataBody:
object
Field value update data
Description
Section titled “Description”Represents the updated data of a field value
UpdateFieldValueDataBody.is_disabled?
Section titled “UpdateFieldValueDataBody.is_disabled?”
optionalis_disabled?:boolean|null
Description
Section titled “Description”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.
UpdateFieldValueDataBody.value?
Section titled “UpdateFieldValueDataBody.value?”
optionalvalue?:string|null
Description
Section titled “Description”The display name of the field value
UpdateFieldValueListBody
Section titled “UpdateFieldValueListBody”UpdateFieldValueListBody:
object
Field value list update
Description
Section titled “Description”Represents the data needed to update multiple field values. It can’t contain more than 1000 values at once.
UpdateFieldValueListBody.items
Section titled “UpdateFieldValueListBody.items”items: ({
brex_id:string;data: {is_disabled?:boolean|null;value?:string|null; }; } | {data: {is_disabled?:boolean|null;value?:string|null; };remote_id:string; } | {data: {is_disabled?:boolean|null;value?:string|null; };value_id:string; })[]
UpdateFieldValueListResponse
Section titled “UpdateFieldValueListResponse”UpdateFieldValueListResponse:
object
Field value updated list
Description
Section titled “Description”Represents a list of updated field values
UpdateFieldValueListResponse.items
Section titled “UpdateFieldValueListResponse.items”items:
object[]
Description
Section titled “Description”The list of updated field values