---
title: FieldsPaths
editUrl: false
head: []
template: doc
prev: false
next: false
sidebar:
  hidden: false
  attrs: {}
pagefind: true
draft: false
---

Defined in: [src/fields/types.gen.ts:2](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L2)

## Properties

### /v1/fields

> **/v1/fields**: `object`

Defined in: [src/fields/types.gen.ts:3](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L3)

#### delete?

> `optional` **delete?**: `undefined`

#### get

> **get**: `object`

List custom fields

##### Description

List custom fields under the same account

##### get.parameters

> **parameters**: `object`

##### get.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### get.parameters.header?

> `optional` **header?**: `undefined`

##### get.parameters.path?

> `optional` **path?**: `undefined`

##### get.parameters.query?

> `optional` **query?**: `object`

##### get.parameters.query.cursor?

> `optional` **cursor?**: `string` \| `null`

###### Description

The cursor to use for pagination. This is the `next_cursor` value returned from the previous response.

##### get.parameters.query.field\_id\[\]?

> `optional` **field\_id\[\]?**: `string`[] \| `null`

###### Description

The Brex identifiers of the field to filter by

###### Example

```ts
extended_field_foobar
```

##### get.parameters.query.limit?

> `optional` **limit?**: `number` \| `null`

###### Description

Controls the maximum number of field values returned in the response. It can't be greater than 1000.

##### get.requestBody?

> `optional` **requestBody?**: `undefined`

##### get.responses

> **responses**: `object`

##### get.responses.200

> **200**: `object`

###### Description

List custom fields response

##### get.responses.200.content

> **content**: `object`

##### get.responses.200.content.application/json

> **application/json**: `object`

##### get.responses.200.content.application/json.items

> **items**: `object`[]

##### get.responses.200.content.application/json.next\_cursor?

> `optional` **next\_cursor?**: `string` \| `null`

##### get.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.400

> **400**: `object`

###### Description

Bad request

##### get.responses.400.content?

> `optional` **content?**: `undefined`

##### get.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.401

> **401**: `object`

###### Description

Unauthorized

##### get.responses.401.content?

> `optional` **content?**: `undefined`

##### get.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.403

> **403**: `object`

###### Description

Forbidden

##### get.responses.403.content?

> `optional` **content?**: `undefined`

##### get.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.500

> **500**: `object`

###### Description

Internal server error

##### get.responses.500.content?

> `optional` **content?**: `undefined`

##### get.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post

> **post**: `object`

Create a custom field

##### Description

Create a custom field

##### post.parameters

> **parameters**: `object`

##### post.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### post.parameters.header

> **header**: `object`

##### post.parameters.header.Idempotency-Key

> **Idempotency-Key**: `string`

###### Description

Idempotency key for this request.

##### post.parameters.path?

> `optional` **path?**: `undefined`

##### post.parameters.query?

> `optional` **query?**: `undefined`

##### post.requestBody

> **requestBody**: `object`

##### post.requestBody.content

> **content**: `object`

##### post.requestBody.content.application/json

> **application/json**: `object`

##### post.requestBody.content.application/json.group

> **group**: `"TRAVEL"` \| `"ACCOUNTING"` \| `"USER"` \| `"ERP"`

##### post.requestBody.content.application/json.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
```

##### post.requestBody.content.application/json.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.

##### post.requestBody.content.application/json.name

> **name**: `string`

###### Description

The name of the field

##### post.requestBody.content.application/json.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
```

##### post.responses

> **responses**: `object`

##### post.responses.200

> **200**: `object`

###### Description

Create custom field response

##### post.responses.200.content

> **content**: `object`

##### post.responses.200.content.application/json

> **application/json**: `object`

##### post.responses.200.content.application/json.brex\_id

> **brex\_id**: `string`

###### Description

The internal Brex ID of the field

###### Example

```ts
extended_field_foobar
```

##### post.responses.200.content.application/json.group?

> `optional` **group?**: `"TRAVEL"` \| `"ACCOUNTING"` \| `"USER"` \| `"ERP"` \| `null`

##### post.responses.200.content.application/json.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.

##### post.responses.200.content.application/json.name

> **name**: `string` \| `null`

###### Description

The name of the field

##### post.responses.200.content.application/json.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
```

##### post.responses.200.content.application/json.updated\_at

> **updated\_at**: `string`

Format: date-time

###### Description

The last updated timestamp of the field

##### post.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.400

> **400**: `object`

###### Description

Bad request

##### post.responses.400.content?

> `optional` **content?**: `undefined`

##### post.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.401

> **401**: `object`

###### Description

Unauthorized

##### post.responses.401.content?

> `optional` **content?**: `undefined`

##### post.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.403

> **403**: `object`

###### Description

Forbidden

##### post.responses.403.content?

> `optional` **content?**: `undefined`

##### post.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.404

> **404**: `object`

###### Description

Not found

##### post.responses.404.content?

> `optional` **content?**: `undefined`

##### post.responses.404.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.500

> **500**: `object`

###### Description

Internal server error

##### post.responses.500.content?

> `optional` **content?**: `undefined`

##### post.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/fields/\{field\_id\}/values

> **/v1/fields/\{field\_id\}/values**: `object`

Defined in: [src/fields/types.gen.ts:27](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L27)

#### delete

> **delete**: `object`

Delete custom field values

##### Description

Delete custom field values (up to 1000 values at once) for a specific field

##### delete.parameters

> **parameters**: `object`

##### delete.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### delete.parameters.header?

> `optional` **header?**: `undefined`

##### delete.parameters.path

> **path**: `object`

##### delete.parameters.path.field\_id

> **field\_id**: `string`

###### Description

The Field Brex identifier

###### Example

```ts
extended_field_foobar
```

##### delete.parameters.query?

> `optional` **query?**: `undefined`

##### delete.requestBody

> **requestBody**: `object`

##### delete.requestBody.content

> **content**: `object`

##### delete.requestBody.content.application/json

> **application/json**: `object`

##### delete.requestBody.content.application/json.items

> **items**: (\{ `brex_id`: `string`; \} \| \{ `remote_id`: `string`; \} \| \{ `value_id`: `string`; \})[]

##### delete.responses

> **responses**: `object`

##### delete.responses.200

> **200**: `object`

###### Description

Delete custom field value list response

##### delete.responses.200.content

> **content**: `object`

##### delete.responses.200.content.application/json

> **application/json**: `Record`\<`string`, `never`\>

##### delete.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### delete.responses.400

> **400**: `object`

###### Description

Bad request

##### delete.responses.400.content?

> `optional` **content?**: `undefined`

##### delete.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### delete.responses.401

> **401**: `object`

###### Description

Unauthorized

##### delete.responses.401.content?

> `optional` **content?**: `undefined`

##### delete.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### delete.responses.403

> **403**: `object`

###### Description

Forbidden

##### delete.responses.403.content?

> `optional` **content?**: `undefined`

##### delete.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### delete.responses.404

> **404**: `object`

###### Description

Not found

##### delete.responses.404.content?

> `optional` **content?**: `undefined`

##### delete.responses.404.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### delete.responses.500

> **500**: `object`

###### Description

Internal server error

##### delete.responses.500.content?

> `optional` **content?**: `undefined`

##### delete.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### get

> **get**: `object`

List custom field values

##### Description

List values under the same custom field

##### get.parameters

> **parameters**: `object`

##### get.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### get.parameters.header?

> `optional` **header?**: `undefined`

##### get.parameters.path

> **path**: `object`

##### get.parameters.path.field\_id

> **field\_id**: `string`

###### Description

The Field Brex identifier

###### Example

```ts
extended_field_foobar
```

##### get.parameters.query?

> `optional` **query?**: `object`

##### get.parameters.query.brex\_id\[\]?

> `optional` **brex\_id\[\]?**: `string`[] \| `null`

###### Description

Field value Brex identifier(s) to filter by

###### Example

```ts
efo_foobar
```

##### get.parameters.query.cursor?

> `optional` **cursor?**: `string` \| `null`

###### Description

The cursor to use for pagination. This is the `next_cursor` value returned from the previous response.

##### get.parameters.query.limit?

> `optional` **limit?**: `number` \| `null`

###### Description

Controls the maximum number of field values returned in the response. It can't be greater than 1000.

##### get.parameters.query.remote\_id\[\]?

> `optional` **remote\_id\[\]?**: `string`[] \| `null`

###### Description

Field value remote identifier(s) to filter by

###### Example

```ts
foo_bar
```

##### get.parameters.query.value?

> `optional` **value?**: `string` \| `null`

###### Description

Field value's value to filter by

###### Example

```ts
Foobar
```

##### get.parameters.query.value\_id\[\]?

> `optional` **value\_id\[\]?**: `string`[] \| `null`

###### Description

Field value identifier(s) to filter by

###### Example

```ts
FooBar
```

##### get.requestBody?

> `optional` **requestBody?**: `undefined`

##### get.responses

> **responses**: `object`

##### get.responses.200

> **200**: `object`

###### Description

List custom field values response

##### get.responses.200.content

> **content**: `object`

##### get.responses.200.content.application/json

> **application/json**: `object`

##### get.responses.200.content.application/json.items

> **items**: `object`[]

##### get.responses.200.content.application/json.next\_cursor?

> `optional` **next\_cursor?**: `string` \| `null`

##### get.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.400

> **400**: `object`

###### Description

Bad request

##### get.responses.400.content?

> `optional` **content?**: `undefined`

##### get.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.401

> **401**: `object`

###### Description

Unauthorized

##### get.responses.401.content?

> `optional` **content?**: `undefined`

##### get.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.403

> **403**: `object`

###### Description

Forbidden

##### get.responses.403.content?

> `optional` **content?**: `undefined`

##### get.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.500

> **500**: `object`

###### Description

Internal server error

##### get.responses.500.content?

> `optional` **content?**: `undefined`

##### get.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post

> **post**: `object`

Create custom field values

##### Description

Create custom field values (up to 1000 values at once) for a specific field

##### post.parameters

> **parameters**: `object`

##### post.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### post.parameters.header

> **header**: `object`

##### post.parameters.header.Idempotency-Key

> **Idempotency-Key**: `string`

###### Description

Idempotency key for this request.

##### post.parameters.path

> **path**: `object`

##### post.parameters.path.field\_id

> **field\_id**: `string`

###### Description

The Field Brex identifier

###### Example

```ts
extended_field_foobar
```

##### post.parameters.query?

> `optional` **query?**: `undefined`

##### post.requestBody

> **requestBody**: `object`

##### post.requestBody.content

> **content**: `object`

##### post.requestBody.content.application/json

> **application/json**: `object`

##### post.requestBody.content.application/json.items

> **items**: `object`[]

###### Description

The list of field values to be created

##### post.responses

> **responses**: `object`

##### post.responses.200

> **200**: `object`

###### Description

Create custom field values response

##### post.responses.200.content

> **content**: `object`

##### post.responses.200.content.application/json

> **application/json**: `object`

##### post.responses.200.content.application/json.items

> **items**: `object`[]

###### Description

The list of created field values

##### post.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.400

> **400**: `object`

###### Description

Bad request

##### post.responses.400.content?

> `optional` **content?**: `undefined`

##### post.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.401

> **401**: `object`

###### Description

Unauthorized

##### post.responses.401.content?

> `optional` **content?**: `undefined`

##### post.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.403

> **403**: `object`

###### Description

Forbidden

##### post.responses.403.content?

> `optional` **content?**: `undefined`

##### post.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.404

> **404**: `object`

###### Description

Not found

##### post.responses.404.content?

> `optional` **content?**: `undefined`

##### post.responses.404.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.500

> **500**: `object`

###### Description

Internal server error

##### post.responses.500.content?

> `optional` **content?**: `undefined`

##### post.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### put

> **put**: `object`

Update custom field values

##### Description

Update custom field values (up to 1000 values at once) for a specific field

##### put.parameters

> **parameters**: `object`

##### put.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### put.parameters.header?

> `optional` **header?**: `undefined`

##### put.parameters.path

> **path**: `object`

##### put.parameters.path.field\_id

> **field\_id**: `string`

###### Description

The Field Brex identifier

###### Example

```ts
extended_field_foobar
```

##### put.parameters.query?

> `optional` **query?**: `undefined`

##### put.requestBody

> **requestBody**: `object`

##### put.requestBody.content

> **content**: `object`

##### put.requestBody.content.application/json

> **application/json**: `object`

##### put.requestBody.content.application/json.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`; \})[]

##### put.responses

> **responses**: `object`

##### put.responses.200

> **200**: `object`

###### Description

Update custom field value list response

##### put.responses.200.content

> **content**: `object`

##### put.responses.200.content.application/json

> **application/json**: `object`

##### put.responses.200.content.application/json.items

> **items**: `object`[]

###### Description

The list of updated field values

##### put.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### put.responses.400

> **400**: `object`

###### Description

Bad request

##### put.responses.400.content?

> `optional` **content?**: `undefined`

##### put.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### put.responses.401

> **401**: `object`

###### Description

Unauthorized

##### put.responses.401.content?

> `optional` **content?**: `undefined`

##### put.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### put.responses.403

> **403**: `object`

###### Description

Forbidden

##### put.responses.403.content?

> `optional` **content?**: `undefined`

##### put.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### put.responses.404

> **404**: `object`

###### Description

Not found

##### put.responses.404.content?

> `optional` **content?**: `undefined`

##### put.responses.404.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### put.responses.500

> **500**: `object`

###### Description

Internal server error

##### put.responses.500.content?

> `optional` **content?**: `undefined`

##### put.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/fields/\{field\_id\}/values/\{brex\_id\}

> **/v1/fields/\{field\_id\}/values/\{brex\_id\}**: `object`

Defined in: [src/fields/types.gen.ts:59](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L59)

#### delete?

> `optional` **delete?**: `undefined`

#### get

> **get**: `object`

Get a field value

##### Description

Get a field value by field ID and field value ID

##### get.parameters

> **parameters**: `object`

##### get.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### get.parameters.header?

> `optional` **header?**: `undefined`

##### get.parameters.path

> **path**: `object`

##### get.parameters.path.brex\_id

> **brex\_id**: `string`

###### Description

The field value ID (`brex_id`) to retrieve.

###### Example

```ts
efo_foobar
```

##### get.parameters.path.field\_id

> **field\_id**: `string`

###### Description

The Field Brex identifier

###### Example

```ts
extended_field_foobar
```

##### get.parameters.query?

> `optional` **query?**: `undefined`

##### get.requestBody?

> `optional` **requestBody?**: `undefined`

##### get.responses

> **responses**: `object`

##### get.responses.200

> **200**: `object`

###### Description

Get a field value response

##### get.responses.200.content

> **content**: `object`

##### get.responses.200.content.application/json

> **application/json**: `object`

##### get.responses.200.content.application/json.brex\_id

> **brex\_id**: `string`

###### Description

The internal Brex ID of the field value

###### Example

```ts
efo_foobar
```

##### get.responses.200.content.application/json.field\_id

> **field\_id**: `string`

###### Description

The ID of the parent field this value belongs to

###### Example

```ts
extended_field_foobar
```

##### get.responses.200.content.application/json.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.

##### get.responses.200.content.application/json.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
```

##### get.responses.200.content.application/json.updated\_at

> **updated\_at**: `string`

Format: date-time

###### Description

The last updated timestamp of the field value

##### get.responses.200.content.application/json.value

> **value**: `string`

###### Description

The display name of the field value

##### get.responses.200.content.application/json.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
```

##### get.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.400

> **400**: `object`

###### Description

Bad request

##### get.responses.400.content?

> `optional` **content?**: `undefined`

##### get.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.401

> **401**: `object`

###### Description

Unauthorized

##### get.responses.401.content?

> `optional` **content?**: `undefined`

##### get.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.403

> **403**: `object`

###### Description

Forbidden

##### get.responses.403.content?

> `optional` **content?**: `undefined`

##### get.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.404

> **404**: `object`

###### Description

Not found

##### get.responses.404.content?

> `optional` **content?**: `undefined`

##### get.responses.404.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.500

> **500**: `object`

###### Description

Internal server error

##### get.responses.500.content?

> `optional` **content?**: `undefined`

##### get.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post?

> `optional` **post?**: `undefined`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/fields/\{id\}

> **/v1/fields/\{id\}**: `object`

Defined in: [src/fields/types.gen.ts:79](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/fields/types.gen.ts#L79)

#### delete

> **delete**: `object`

Delete a custom field

##### Description

Delete a custom field by Brex ID

##### delete.parameters

> **parameters**: `object`

##### delete.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### delete.parameters.header?

> `optional` **header?**: `undefined`

##### delete.parameters.path

> **path**: `object`

##### delete.parameters.path.id

> **id**: `string`

###### Description

The Brex identifier of the field to delete

###### Example

```ts
extended_field_foobar
```

##### delete.parameters.query?

> `optional` **query?**: `undefined`

##### delete.requestBody?

> `optional` **requestBody?**: `undefined`

##### delete.responses

> **responses**: `object`

##### delete.responses.200

> **200**: `object`

###### Description

Delete custom field response

##### delete.responses.200.content?

> `optional` **content?**: `undefined`

##### delete.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### delete.responses.400

> **400**: `object`

###### Description

Bad request

##### delete.responses.400.content?

> `optional` **content?**: `undefined`

##### delete.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### delete.responses.401

> **401**: `object`

###### Description

Unauthorized

##### delete.responses.401.content?

> `optional` **content?**: `undefined`

##### delete.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### delete.responses.403

> **403**: `object`

###### Description

Forbidden

##### delete.responses.403.content?

> `optional` **content?**: `undefined`

##### delete.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### delete.responses.404

> **404**: `object`

###### Description

Not found

##### delete.responses.404.content?

> `optional` **content?**: `undefined`

##### delete.responses.404.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### delete.responses.500

> **500**: `object`

###### Description

Internal server error

##### delete.responses.500.content?

> `optional` **content?**: `undefined`

##### delete.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### get

> **get**: `object`

Get custom field

##### Description

Get a custom field by Brex ID

##### get.parameters

> **parameters**: `object`

##### get.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### get.parameters.header?

> `optional` **header?**: `undefined`

##### get.parameters.path

> **path**: `object`

##### get.parameters.path.id

> **id**: `string`

###### Description

The Brex identifier of the field to retrieve

###### Example

```ts
extended_field_foobar
```

##### get.parameters.query?

> `optional` **query?**: `undefined`

##### get.requestBody?

> `optional` **requestBody?**: `undefined`

##### get.responses

> **responses**: `object`

##### get.responses.200

> **200**: `object`

###### Description

Get custom field response

##### get.responses.200.content

> **content**: `object`

##### get.responses.200.content.application/json

> **application/json**: `object`

##### get.responses.200.content.application/json.brex\_id

> **brex\_id**: `string`

###### Description

The internal Brex ID of the field

###### Example

```ts
extended_field_foobar
```

##### get.responses.200.content.application/json.group?

> `optional` **group?**: `"TRAVEL"` \| `"ACCOUNTING"` \| `"USER"` \| `"ERP"` \| `null`

##### get.responses.200.content.application/json.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.

##### get.responses.200.content.application/json.name

> **name**: `string` \| `null`

###### Description

The name of the field

##### get.responses.200.content.application/json.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
```

##### get.responses.200.content.application/json.updated\_at

> **updated\_at**: `string`

Format: date-time

###### Description

The last updated timestamp of the field

##### get.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.400

> **400**: `object`

###### Description

Bad request

##### get.responses.400.content?

> `optional` **content?**: `undefined`

##### get.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.401

> **401**: `object`

###### Description

Unauthorized

##### get.responses.401.content?

> `optional` **content?**: `undefined`

##### get.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.403

> **403**: `object`

###### Description

Forbidden

##### get.responses.403.content?

> `optional` **content?**: `undefined`

##### get.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.404

> **404**: `object`

###### Description

Not found

##### get.responses.404.content?

> `optional` **content?**: `undefined`

##### get.responses.404.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.500

> **500**: `object`

###### Description

Internal server error

##### get.responses.500.content?

> `optional` **content?**: `undefined`

##### get.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post?

> `optional` **post?**: `undefined`

#### put

> **put**: `object`

Update a custom field

##### Description

Update a field by ID

##### put.parameters

> **parameters**: `object`

##### put.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### put.parameters.header?

> `optional` **header?**: `undefined`

##### put.parameters.path

> **path**: `object`

##### put.parameters.path.id

> **id**: `string`

###### Description

The Brex identifier of the field to update

###### Example

```ts
extended_field_foobar
```

##### put.parameters.query?

> `optional` **query?**: `undefined`

##### put.requestBody

> **requestBody**: `object`

##### put.requestBody.content

> **content**: `object`

##### put.requestBody.content.application/json

> **application/json**: `object`

##### put.requestBody.content.application/json.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.

##### put.requestBody.content.application/json.name?

> `optional` **name?**: `string` \| `null`

###### Description

The name of the field

##### put.responses

> **responses**: `object`

##### put.responses.200

> **200**: `object`

###### Description

Update custom field response

##### put.responses.200.content

> **content**: `object`

##### put.responses.200.content.application/json

> **application/json**: `object`

##### put.responses.200.content.application/json.brex\_id

> **brex\_id**: `string`

###### Description

The internal Brex ID of the field

###### Example

```ts
extended_field_foobar
```

##### put.responses.200.content.application/json.group?

> `optional` **group?**: `"TRAVEL"` \| `"ACCOUNTING"` \| `"USER"` \| `"ERP"` \| `null`

##### put.responses.200.content.application/json.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.

##### put.responses.200.content.application/json.name

> **name**: `string` \| `null`

###### Description

The name of the field

##### put.responses.200.content.application/json.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
```

##### put.responses.200.content.application/json.updated\_at

> **updated\_at**: `string`

Format: date-time

###### Description

The last updated timestamp of the field

##### put.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### put.responses.400

> **400**: `object`

###### Description

Bad request

##### put.responses.400.content?

> `optional` **content?**: `undefined`

##### put.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### put.responses.401

> **401**: `object`

###### Description

Unauthorized

##### put.responses.401.content?

> `optional` **content?**: `undefined`

##### put.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### put.responses.403

> **403**: `object`

###### Description

Forbidden

##### put.responses.403.content?

> `optional` **content?**: `undefined`

##### put.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### put.responses.404

> **404**: `object`

###### Description

Not found

##### put.responses.404.content?

> `optional` **content?**: `undefined`

##### put.responses.404.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### put.responses.500

> **500**: `object`

###### Description

Internal server error

##### put.responses.500.content?

> `optional` **content?**: `undefined`

##### put.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### trace?

> `optional` **trace?**: `undefined`