--- title: FieldsComponents editUrl: false head: [] template: doc prev: false next: false sidebar: hidden: false attrs: {} pagefind: true draft: false --- Defined in: [src/fields/types.gen.ts:109](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L109) ## Properties ### headers > **headers**: `never` Defined in: [src/fields/types.gen.ts:386](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L386) *** ### parameters > **parameters**: `never` Defined in: [src/fields/types.gen.ts:384](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L384) *** ### pathItems > **pathItems**: `never` Defined in: [src/fields/types.gen.ts:387](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L387) *** ### requestBodies > **requestBodies**: `never` Defined in: [src/fields/types.gen.ts:385](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L385) *** ### responses > **responses**: `never` Defined in: [src/fields/types.gen.ts:383](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L383) *** ### schemas > **schemas**: `object` Defined in: [src/fields/types.gen.ts:110](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L110) #### CreateFieldValueBody > **CreateFieldValueBody**: `object` Field value creation ##### Description Represents the data needed to create a field value ##### CreateFieldValueBody.is\_disabled? > `optional` **is\_disabled?**: `boolean` \| `null` ###### 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? > `optional` **remote\_id?**: `string` \| `null` ###### Description Remote/external ID of custom field value from external system (e.g. ERP or HRIS system) ###### Example ```ts foo_bar ``` ##### CreateFieldValueBody.value > **value**: `string` ###### Description The display name of the field value ##### CreateFieldValueBody.value\_id? > `optional` **value\_id?**: `string` \| `null` ###### 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 ```ts FooBar ``` #### CreateFieldValueListBody > **CreateFieldValueListBody**: `object` Field value list creation ##### Description Represents the data needed to create multiple field values. It can't contain more than 1000 values at once. ##### CreateFieldValueListBody.items > **items**: `object`[] ###### Description The list of field values to be created #### CreateFieldValueListResponse > **CreateFieldValueListResponse**: `object` Field value list ##### Description Represents a list of field values definition ##### CreateFieldValueListResponse.items > **items**: `object`[] ###### Description The list of created field values #### DeletedFieldValueListResponse > **DeletedFieldValueListResponse**: `Record`\<`string`, `never`\> Field value deleted response ##### Description Represents the confirmation of number of deleted field values ##### DeleteFieldValue.ByBrexId > **DeleteFieldValue.ByBrexId**: `object` by `brex_id` ###### Description Represents the data needed to delete a field value using its `brex_id`. ##### DeleteFieldValue.ByBrexId.brex\_id > **brex\_id**: `string` ###### Description The internal Brex ID of the field value ###### Example ```ts efo_foobar ``` ##### DeleteFieldValue.ByRemoteId > **DeleteFieldValue.ByRemoteId**: `object` by `remote_id` ###### Description Represents the data needed to delete a field value using its `remote_id`. ##### DeleteFieldValue.ByRemoteId.remote\_id > **remote\_id**: `string` ###### Description Remote/external ID of custom field value from external system (e.g. ERP or HRIS system) ###### Example ```ts foo_bar ``` ##### DeleteFieldValue.ByValueId > **DeleteFieldValue.ByValueId**: `object` by `value_id` ###### Description Represents the data needed to delete a field value using its `value_id`. ##### DeleteFieldValue.ByValueId.value\_id > **value\_id**: `string` ###### 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 ```ts FooBar ``` #### DeleteFieldValueBody > **DeleteFieldValueBody**: \{ `brex_id`: `string`; \} \| \{ `remote_id`: `string`; \} \| \{ `value_id`: `string`; \} Field value to delete ##### Union Members ###### Type Literal \{ `brex_id`: `string`; \} ###### brex\_id > **brex\_id**: `string` ###### Description The internal Brex ID of the field value ###### Example ```ts efo_foobar ``` *** ###### Type Literal \{ `remote_id`: `string`; \} ###### remote\_id > **remote\_id**: `string` ###### Description Remote/external ID of custom field value from external system (e.g. ERP or HRIS system) ###### Example ```ts foo_bar ``` *** ###### Type Literal \{ `value_id`: `string`; \} ###### value\_id > **value\_id**: `string` ###### 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 ```ts FooBar ``` ##### Description Represents the data needed to delete a field value. #### DeleteFieldValueListBody > **DeleteFieldValueListBody**: `object` Field value list deletion ##### Description Represents the data needed to delete field values. It can't contain more than 1000 values at once. ##### DeleteFieldValueListBody.items > **items**: (\{ `brex_id`: `string`; \} \| \{ `remote_id`: `string`; \} \| \{ `value_id`: `string`; \})[] #### Field > **Field**: `object` Field ##### Description Represents a field definition ##### Field.brex\_id > **brex\_id**: `string` ###### Description The internal Brex ID of the field ###### Example ```ts extended_field_foobar ``` ##### Field.group? > `optional` **group?**: `"TRAVEL"` \| `"ACCOUNTING"` \| `"USER"` \| `"ERP"` \| `null` ##### Field.is\_disabled > **is\_disabled**: `boolean` ###### 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 > **name**: `string` \| `null` ###### Description The name of the field ##### Field.remote\_id? > `optional` **remote\_id?**: `string` \| `null` ###### Description Remote/external ID of custom field from external system (e.g. ERP or HRIS system) ###### Example ```ts foo_bar ``` ##### Field.updated\_at > **updated\_at**: `string` Format: date-time ###### Description The last updated timestamp of the field #### FieldCreateBody > **FieldCreateBody**: `object` Field creation ##### 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 > **group**: `"TRAVEL"` \| `"ACCOUNTING"` \| `"USER"` \| `"ERP"` ##### FieldCreateBody.integration\_id? > `optional` **integration\_id?**: `string` \| `null` ###### 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 ```ts int_123 ``` ##### FieldCreateBody.is\_disabled? > `optional` **is\_disabled?**: `boolean` \| `null` ###### 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 > **name**: `string` ###### Description The name of the field ##### FieldCreateBody.remote\_id? > `optional` **remote\_id?**: `string` \| `null` ###### Description Remote/external ID of custom field from external system (e.g. ERP or HRIS system) ###### Example ```ts foo_bar ``` #### FieldGroup > **FieldGroup**: `"TRAVEL"` \| `"ACCOUNTING"` \| `"USER"` \| `"ERP"` ##### 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 > **FieldUpdateBody**: `object` Field update ##### Description Represents the data needed to update a field ##### FieldUpdateBody.is\_disabled? > `optional` **is\_disabled?**: `boolean` \| `null` ###### 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? > `optional` **name?**: `string` \| `null` ###### Description The name of the field #### FieldValue > **FieldValue**: `object` Field value ##### Description Represents a field value definition ##### FieldValue.brex\_id > **brex\_id**: `string` ###### Description The internal Brex ID of the field value ###### Example ```ts efo_foobar ``` ##### FieldValue.field\_id > **field\_id**: `string` ###### Description The ID of the parent field this value belongs to ###### Example ```ts extended_field_foobar ``` ##### FieldValue.is\_disabled > **is\_disabled**: `boolean` ###### 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? > `optional` **remote\_id?**: `string` \| `null` ###### Description Remote/external ID of custom field value from external system (e.g. ERP or HRIS system) ###### Example ```ts foo_bar ``` ##### FieldValue.updated\_at > **updated\_at**: `string` Format: date-time ###### Description The last updated timestamp of the field value ##### FieldValue.value > **value**: `string` ###### Description The display name of the field value ##### FieldValue.value\_id? > `optional` **value\_id?**: `string` \| `null` ###### 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 ```ts foo_bar ``` #### Page\_Field\_ > **Page\_Field\_**: `object` ##### Page\_Field\_.items > **items**: `object`[] ##### Page\_Field\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### Page\_FieldValue\_ > **Page\_FieldValue\_**: `object` ##### Page\_FieldValue\_.items > **items**: `object`[] ##### Page\_FieldValue\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` ##### UpdateFieldValue.ByBrexId > **UpdateFieldValue.ByBrexId**: `object` by `brex_id` ###### Description Represents the data needed to update a field value using its `brex_id`. ##### UpdateFieldValue.ByBrexId.brex\_id > **brex\_id**: `string` ###### Description The internal Brex ID of the field value ###### Example ```ts efo_foobar ``` ##### UpdateFieldValue.ByBrexId.data > **data**: `object` ##### UpdateFieldValue.ByBrexId.data.is\_disabled? > `optional` **is\_disabled?**: `boolean` \| `null` ###### 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? > `optional` **value?**: `string` \| `null` ###### Description The display name of the field value ##### UpdateFieldValue.ByRemoteId > **UpdateFieldValue.ByRemoteId**: `object` by `remote_id` ###### Description Represents the data needed to update a field value using its `remote_id`. ##### UpdateFieldValue.ByRemoteId.data > **data**: `object` ##### UpdateFieldValue.ByRemoteId.data.is\_disabled? > `optional` **is\_disabled?**: `boolean` \| `null` ###### 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? > `optional` **value?**: `string` \| `null` ###### Description The display name of the field value ##### UpdateFieldValue.ByRemoteId.remote\_id > **remote\_id**: `string` ###### Description Remote/external ID of custom field value from external system (e.g. ERP or HRIS system) ###### Example ```ts foo_bar ``` ##### UpdateFieldValue.ByValueId > **UpdateFieldValue.ByValueId**: `object` by `value_id` ###### Description Represents the data needed to update a field value using its `value_id`. ##### UpdateFieldValue.ByValueId.data > **data**: `object` ##### UpdateFieldValue.ByValueId.data.is\_disabled? > `optional` **is\_disabled?**: `boolean` \| `null` ###### 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? > `optional` **value?**: `string` \| `null` ###### Description The display name of the field value ##### UpdateFieldValue.ByValueId.value\_id > **value\_id**: `string` ###### 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 ```ts FooBar ``` #### 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 ###### Type Literal \{ `brex_id`: `string`; `data`: \{ `is_disabled?`: `boolean` \| `null`; `value?`: `string` \| `null`; \}; \} ###### brex\_id > **brex\_id**: `string` ###### Description The internal Brex ID of the field value ###### Example ```ts efo_foobar ``` ###### data > **data**: `object` ###### data.is\_disabled? > `optional` **is\_disabled?**: `boolean` \| `null` ###### 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? > `optional` **value?**: `string` \| `null` ###### Description The display name of the field value *** ###### Type Literal \{ `data`: \{ `is_disabled?`: `boolean` \| `null`; `value?`: `string` \| `null`; \}; `remote_id`: `string`; \} ###### data > **data**: `object` ###### data.is\_disabled? > `optional` **is\_disabled?**: `boolean` \| `null` ###### 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? > `optional` **value?**: `string` \| `null` ###### Description The display name of the field value ###### remote\_id > **remote\_id**: `string` ###### Description Remote/external ID of custom field value from external system (e.g. ERP or HRIS system) ###### Example ```ts foo_bar ``` *** ###### Type Literal \{ `data`: \{ `is_disabled?`: `boolean` \| `null`; `value?`: `string` \| `null`; \}; `value_id`: `string`; \} ###### data > **data**: `object` ###### data.is\_disabled? > `optional` **is\_disabled?**: `boolean` \| `null` ###### 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? > `optional` **value?**: `string` \| `null` ###### Description The display name of the field value ###### value\_id > **value\_id**: `string` ###### 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 ```ts FooBar ``` ##### Description Represents the data needed to update a field value. #### UpdateFieldValueDataBody > **UpdateFieldValueDataBody**: `object` Field value update data ##### Description Represents the updated data of a field value ##### UpdateFieldValueDataBody.is\_disabled? > `optional` **is\_disabled?**: `boolean` \| `null` ###### 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? > `optional` **value?**: `string` \| `null` ###### Description The display name of the field value #### UpdateFieldValueListBody > **UpdateFieldValueListBody**: `object` Field value list update ##### Description Represents the data needed to update multiple field values. It can't contain more than 1000 values at once. ##### 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 > **UpdateFieldValueListResponse**: `object` Field value updated list ##### Description Represents a list of updated field values ##### UpdateFieldValueListResponse.items > **items**: `object`[] ###### Description The list of updated field values