FieldsPaths
Defined in: src/fields/types.gen.ts:2
Properties
Section titled “Properties”/v1/fields
Section titled “/v1/fields”/v1/fields:
object
Defined in: src/fields/types.gen.ts:3
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
List custom fields
Description
Section titled “Description”List custom fields under the same account
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path?
Section titled “get.parameters.path?”
optionalpath?:undefined
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:object
get.parameters.query.cursor?
Section titled “get.parameters.query.cursor?”
optionalcursor?:string|null
Description
Section titled “Description”The cursor to use for pagination. This is the next_cursor value returned from the previous response.
get.parameters.query.field_id[]?
Section titled “get.parameters.query.field_id[]?”
optionalfield_id[]?:string[] |null
Description
Section titled “Description”The Brex identifiers of the field to filter by
Example
Section titled “Example”extended_field_foobarget.parameters.query.limit?
Section titled “get.parameters.query.limit?”
optionallimit?:number|null
Description
Section titled “Description”Controls the maximum number of field values returned in the response. It can’t be greater than 1000.
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”List custom fields response
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.items
Section titled “get.responses.200.content.application/json.items”items:
object[]
get.responses.200.content.application/json.next_cursor?
Section titled “get.responses.200.content.application/json.next_cursor?”
optionalnext_cursor?:string|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.400
Section titled “get.responses.400”400:
object
Description
Section titled “Description”Bad request
get.responses.400.content?
Section titled “get.responses.400.content?”
optionalcontent?:undefined
get.responses.400.headers
Section titled “get.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.401
Section titled “get.responses.401”401:
object
Description
Section titled “Description”Unauthorized
get.responses.401.content?
Section titled “get.responses.401.content?”
optionalcontent?:undefined
get.responses.401.headers
Section titled “get.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.403
Section titled “get.responses.403”403:
object
Description
Section titled “Description”Forbidden
get.responses.403.content?
Section titled “get.responses.403.content?”
optionalcontent?:undefined
get.responses.403.headers
Section titled “get.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.500
Section titled “get.responses.500”500:
object
Description
Section titled “Description”Internal server error
get.responses.500.content?
Section titled “get.responses.500.content?”
optionalcontent?:undefined
get.responses.500.headers
Section titled “get.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Create a custom field
Description
Section titled “Description”Create a custom field
post.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header
Section titled “post.parameters.header”header:
object
post.parameters.header.Idempotency-Key
Section titled “post.parameters.header.Idempotency-Key”Idempotency-Key:
string
Description
Section titled “Description”Idempotency key for this request.
post.parameters.path?
Section titled “post.parameters.path?”
optionalpath?:undefined
post.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody
Section titled “post.requestBody”requestBody:
object
post.requestBody.content
Section titled “post.requestBody.content”content:
object
post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”application/json:
object
post.requestBody.content.application/json.group
Section titled “post.requestBody.content.application/json.group”group:
"TRAVEL"|"ACCOUNTING"|"USER"|"ERP"
post.requestBody.content.application/json.integration_id?
Section titled “post.requestBody.content.application/json.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_123post.requestBody.content.application/json.is_disabled?
Section titled “post.requestBody.content.application/json.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.
post.requestBody.content.application/json.name
Section titled “post.requestBody.content.application/json.name”name:
string
Description
Section titled “Description”The name of the field
post.requestBody.content.application/json.remote_id?
Section titled “post.requestBody.content.application/json.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_barpost.responses
Section titled “post.responses”responses:
object
post.responses.200
Section titled “post.responses.200”200:
object
Description
Section titled “Description”Create custom field response
post.responses.200.content
Section titled “post.responses.200.content”content:
object
post.responses.200.content.application/json
Section titled “post.responses.200.content.application/json”application/json:
object
post.responses.200.content.application/json.brex_id
Section titled “post.responses.200.content.application/json.brex_id”brex_id:
string
Description
Section titled “Description”The internal Brex ID of the field
Example
Section titled “Example”extended_field_foobarpost.responses.200.content.application/json.group?
Section titled “post.responses.200.content.application/json.group?”
optionalgroup?:"TRAVEL"|"ACCOUNTING"|"USER"|"ERP"|null
post.responses.200.content.application/json.is_disabled
Section titled “post.responses.200.content.application/json.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.
post.responses.200.content.application/json.name
Section titled “post.responses.200.content.application/json.name”name:
string|null
Description
Section titled “Description”The name of the field
post.responses.200.content.application/json.remote_id?
Section titled “post.responses.200.content.application/json.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_barpost.responses.200.content.application/json.updated_at
Section titled “post.responses.200.content.application/json.updated_at”updated_at:
string
Format: date-time
Description
Section titled “Description”The last updated timestamp of the field
post.responses.200.headers
Section titled “post.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.400
Section titled “post.responses.400”400:
object
Description
Section titled “Description”Bad request
post.responses.400.content?
Section titled “post.responses.400.content?”
optionalcontent?:undefined
post.responses.400.headers
Section titled “post.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.401
Section titled “post.responses.401”401:
object
Description
Section titled “Description”Unauthorized
post.responses.401.content?
Section titled “post.responses.401.content?”
optionalcontent?:undefined
post.responses.401.headers
Section titled “post.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.403
Section titled “post.responses.403”403:
object
Description
Section titled “Description”Forbidden
post.responses.403.content?
Section titled “post.responses.403.content?”
optionalcontent?:undefined
post.responses.403.headers
Section titled “post.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.404
Section titled “post.responses.404”404:
object
Description
Section titled “Description”Not found
post.responses.404.content?
Section titled “post.responses.404.content?”
optionalcontent?:undefined
post.responses.404.headers
Section titled “post.responses.404.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.500
Section titled “post.responses.500”500:
object
Description
Section titled “Description”Internal server error
post.responses.500.content?
Section titled “post.responses.500.content?”
optionalcontent?:undefined
post.responses.500.headers
Section titled “post.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/fields/{field_id}/values
Section titled “/v1/fields/{field_id}/values”/v1/fields/{field_id}/values:
object
Defined in: src/fields/types.gen.ts:27
delete
Section titled “delete”delete:
object
Delete custom field values
Description
Section titled “Description”Delete custom field values (up to 1000 values at once) for a specific field
delete.parameters
Section titled “delete.parameters”parameters:
object
delete.parameters.cookie?
Section titled “delete.parameters.cookie?”
optionalcookie?:undefined
delete.parameters.header?
Section titled “delete.parameters.header?”
optionalheader?:undefined
delete.parameters.path
Section titled “delete.parameters.path”path:
object
delete.parameters.path.field_id
Section titled “delete.parameters.path.field_id”field_id:
string
Description
Section titled “Description”The Field Brex identifier
Example
Section titled “Example”extended_field_foobardelete.parameters.query?
Section titled “delete.parameters.query?”
optionalquery?:undefined
delete.requestBody
Section titled “delete.requestBody”requestBody:
object
delete.requestBody.content
Section titled “delete.requestBody.content”content:
object
delete.requestBody.content.application/json
Section titled “delete.requestBody.content.application/json”application/json:
object
delete.requestBody.content.application/json.items
Section titled “delete.requestBody.content.application/json.items”items: ({
brex_id:string; } | {remote_id:string; } | {value_id:string; })[]
delete.responses
Section titled “delete.responses”responses:
object
delete.responses.200
Section titled “delete.responses.200”200:
object
Description
Section titled “Description”Delete custom field value list response
delete.responses.200.content
Section titled “delete.responses.200.content”content:
object
delete.responses.200.content.application/json
Section titled “delete.responses.200.content.application/json”application/json:
Record<string,never>
delete.responses.200.headers
Section titled “delete.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
delete.responses.400
Section titled “delete.responses.400”400:
object
Description
Section titled “Description”Bad request
delete.responses.400.content?
Section titled “delete.responses.400.content?”
optionalcontent?:undefined
delete.responses.400.headers
Section titled “delete.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
delete.responses.401
Section titled “delete.responses.401”401:
object
Description
Section titled “Description”Unauthorized
delete.responses.401.content?
Section titled “delete.responses.401.content?”
optionalcontent?:undefined
delete.responses.401.headers
Section titled “delete.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
delete.responses.403
Section titled “delete.responses.403”403:
object
Description
Section titled “Description”Forbidden
delete.responses.403.content?
Section titled “delete.responses.403.content?”
optionalcontent?:undefined
delete.responses.403.headers
Section titled “delete.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
delete.responses.404
Section titled “delete.responses.404”404:
object
Description
Section titled “Description”Not found
delete.responses.404.content?
Section titled “delete.responses.404.content?”
optionalcontent?:undefined
delete.responses.404.headers
Section titled “delete.responses.404.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
delete.responses.500
Section titled “delete.responses.500”500:
object
Description
Section titled “Description”Internal server error
delete.responses.500.content?
Section titled “delete.responses.500.content?”
optionalcontent?:undefined
delete.responses.500.headers
Section titled “delete.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get:
object
List custom field values
Description
Section titled “Description”List values under the same custom field
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path
Section titled “get.parameters.path”path:
object
get.parameters.path.field_id
Section titled “get.parameters.path.field_id”field_id:
string
Description
Section titled “Description”The Field Brex identifier
Example
Section titled “Example”extended_field_foobarget.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:object
get.parameters.query.brex_id[]?
Section titled “get.parameters.query.brex_id[]?”
optionalbrex_id[]?:string[] |null
Description
Section titled “Description”Field value Brex identifier(s) to filter by
Example
Section titled “Example”efo_foobarget.parameters.query.cursor?
Section titled “get.parameters.query.cursor?”
optionalcursor?:string|null
Description
Section titled “Description”The cursor to use for pagination. This is the next_cursor value returned from the previous response.
get.parameters.query.limit?
Section titled “get.parameters.query.limit?”
optionallimit?:number|null
Description
Section titled “Description”Controls the maximum number of field values returned in the response. It can’t be greater than 1000.
get.parameters.query.remote_id[]?
Section titled “get.parameters.query.remote_id[]?”
optionalremote_id[]?:string[] |null
Description
Section titled “Description”Field value remote identifier(s) to filter by
Example
Section titled “Example”foo_barget.parameters.query.value?
Section titled “get.parameters.query.value?”
optionalvalue?:string|null
Description
Section titled “Description”Field value’s value to filter by
Example
Section titled “Example”Foobarget.parameters.query.value_id[]?
Section titled “get.parameters.query.value_id[]?”
optionalvalue_id[]?:string[] |null
Description
Section titled “Description”Field value identifier(s) to filter by
Example
Section titled “Example”FooBarget.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”List custom field values response
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.items
Section titled “get.responses.200.content.application/json.items”items:
object[]
get.responses.200.content.application/json.next_cursor?
Section titled “get.responses.200.content.application/json.next_cursor?”
optionalnext_cursor?:string|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.400
Section titled “get.responses.400”400:
object
Description
Section titled “Description”Bad request
get.responses.400.content?
Section titled “get.responses.400.content?”
optionalcontent?:undefined
get.responses.400.headers
Section titled “get.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.401
Section titled “get.responses.401”401:
object
Description
Section titled “Description”Unauthorized
get.responses.401.content?
Section titled “get.responses.401.content?”
optionalcontent?:undefined
get.responses.401.headers
Section titled “get.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.403
Section titled “get.responses.403”403:
object
Description
Section titled “Description”Forbidden
get.responses.403.content?
Section titled “get.responses.403.content?”
optionalcontent?:undefined
get.responses.403.headers
Section titled “get.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.500
Section titled “get.responses.500”500:
object
Description
Section titled “Description”Internal server error
get.responses.500.content?
Section titled “get.responses.500.content?”
optionalcontent?:undefined
get.responses.500.headers
Section titled “get.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Create custom field values
Description
Section titled “Description”Create custom field values (up to 1000 values at once) for a specific field
post.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header
Section titled “post.parameters.header”header:
object
post.parameters.header.Idempotency-Key
Section titled “post.parameters.header.Idempotency-Key”Idempotency-Key:
string
Description
Section titled “Description”Idempotency key for this request.
post.parameters.path
Section titled “post.parameters.path”path:
object
post.parameters.path.field_id
Section titled “post.parameters.path.field_id”field_id:
string
Description
Section titled “Description”The Field Brex identifier
Example
Section titled “Example”extended_field_foobarpost.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody
Section titled “post.requestBody”requestBody:
object
post.requestBody.content
Section titled “post.requestBody.content”content:
object
post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”application/json:
object
post.requestBody.content.application/json.items
Section titled “post.requestBody.content.application/json.items”items:
object[]
Description
Section titled “Description”The list of field values to be created
post.responses
Section titled “post.responses”responses:
object
post.responses.200
Section titled “post.responses.200”200:
object
Description
Section titled “Description”Create custom field values response
post.responses.200.content
Section titled “post.responses.200.content”content:
object
post.responses.200.content.application/json
Section titled “post.responses.200.content.application/json”application/json:
object
post.responses.200.content.application/json.items
Section titled “post.responses.200.content.application/json.items”items:
object[]
Description
Section titled “Description”The list of created field values
post.responses.200.headers
Section titled “post.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.400
Section titled “post.responses.400”400:
object
Description
Section titled “Description”Bad request
post.responses.400.content?
Section titled “post.responses.400.content?”
optionalcontent?:undefined
post.responses.400.headers
Section titled “post.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.401
Section titled “post.responses.401”401:
object
Description
Section titled “Description”Unauthorized
post.responses.401.content?
Section titled “post.responses.401.content?”
optionalcontent?:undefined
post.responses.401.headers
Section titled “post.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.403
Section titled “post.responses.403”403:
object
Description
Section titled “Description”Forbidden
post.responses.403.content?
Section titled “post.responses.403.content?”
optionalcontent?:undefined
post.responses.403.headers
Section titled “post.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.404
Section titled “post.responses.404”404:
object
Description
Section titled “Description”Not found
post.responses.404.content?
Section titled “post.responses.404.content?”
optionalcontent?:undefined
post.responses.404.headers
Section titled “post.responses.404.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.500
Section titled “post.responses.500”500:
object
Description
Section titled “Description”Internal server error
post.responses.500.content?
Section titled “post.responses.500.content?”
optionalcontent?:undefined
post.responses.500.headers
Section titled “post.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
put:
object
Update custom field values
Description
Section titled “Description”Update custom field values (up to 1000 values at once) for a specific field
put.parameters
Section titled “put.parameters”parameters:
object
put.parameters.cookie?
Section titled “put.parameters.cookie?”
optionalcookie?:undefined
put.parameters.header?
Section titled “put.parameters.header?”
optionalheader?:undefined
put.parameters.path
Section titled “put.parameters.path”path:
object
put.parameters.path.field_id
Section titled “put.parameters.path.field_id”field_id:
string
Description
Section titled “Description”The Field Brex identifier
Example
Section titled “Example”extended_field_foobarput.parameters.query?
Section titled “put.parameters.query?”
optionalquery?:undefined
put.requestBody
Section titled “put.requestBody”requestBody:
object
put.requestBody.content
Section titled “put.requestBody.content”content:
object
put.requestBody.content.application/json
Section titled “put.requestBody.content.application/json”application/json:
object
put.requestBody.content.application/json.items
Section titled “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
Section titled “put.responses”responses:
object
put.responses.200
Section titled “put.responses.200”200:
object
Description
Section titled “Description”Update custom field value list response
put.responses.200.content
Section titled “put.responses.200.content”content:
object
put.responses.200.content.application/json
Section titled “put.responses.200.content.application/json”application/json:
object
put.responses.200.content.application/json.items
Section titled “put.responses.200.content.application/json.items”items:
object[]
Description
Section titled “Description”The list of updated field values
put.responses.200.headers
Section titled “put.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
put.responses.400
Section titled “put.responses.400”400:
object
Description
Section titled “Description”Bad request
put.responses.400.content?
Section titled “put.responses.400.content?”
optionalcontent?:undefined
put.responses.400.headers
Section titled “put.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
put.responses.401
Section titled “put.responses.401”401:
object
Description
Section titled “Description”Unauthorized
put.responses.401.content?
Section titled “put.responses.401.content?”
optionalcontent?:undefined
put.responses.401.headers
Section titled “put.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
put.responses.403
Section titled “put.responses.403”403:
object
Description
Section titled “Description”Forbidden
put.responses.403.content?
Section titled “put.responses.403.content?”
optionalcontent?:undefined
put.responses.403.headers
Section titled “put.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
put.responses.404
Section titled “put.responses.404”404:
object
Description
Section titled “Description”Not found
put.responses.404.content?
Section titled “put.responses.404.content?”
optionalcontent?:undefined
put.responses.404.headers
Section titled “put.responses.404.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
put.responses.500
Section titled “put.responses.500”500:
object
Description
Section titled “Description”Internal server error
put.responses.500.content?
Section titled “put.responses.500.content?”
optionalcontent?:undefined
put.responses.500.headers
Section titled “put.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/fields/{field_id}/values/{brex_id}
Section titled “/v1/fields/{field_id}/values/{brex_id}”/v1/fields/{field_id}/values/{brex_id}:
object
Defined in: src/fields/types.gen.ts:59
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
Get a field value
Description
Section titled “Description”Get a field value by field ID and field value ID
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path
Section titled “get.parameters.path”path:
object
get.parameters.path.brex_id
Section titled “get.parameters.path.brex_id”brex_id:
string
Description
Section titled “Description”The field value ID (brex_id) to retrieve.
Example
Section titled “Example”efo_foobarget.parameters.path.field_id
Section titled “get.parameters.path.field_id”field_id:
string
Description
Section titled “Description”The Field Brex identifier
Example
Section titled “Example”extended_field_foobarget.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:undefined
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”Get a field value response
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.brex_id
Section titled “get.responses.200.content.application/json.brex_id”brex_id:
string
Description
Section titled “Description”The internal Brex ID of the field value
Example
Section titled “Example”efo_foobarget.responses.200.content.application/json.field_id
Section titled “get.responses.200.content.application/json.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_foobarget.responses.200.content.application/json.is_disabled
Section titled “get.responses.200.content.application/json.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.
get.responses.200.content.application/json.remote_id?
Section titled “get.responses.200.content.application/json.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_barget.responses.200.content.application/json.updated_at
Section titled “get.responses.200.content.application/json.updated_at”updated_at:
string
Format: date-time
Description
Section titled “Description”The last updated timestamp of the field value
get.responses.200.content.application/json.value
Section titled “get.responses.200.content.application/json.value”value:
string
Description
Section titled “Description”The display name of the field value
get.responses.200.content.application/json.value_id?
Section titled “get.responses.200.content.application/json.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_barget.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.400
Section titled “get.responses.400”400:
object
Description
Section titled “Description”Bad request
get.responses.400.content?
Section titled “get.responses.400.content?”
optionalcontent?:undefined
get.responses.400.headers
Section titled “get.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.401
Section titled “get.responses.401”401:
object
Description
Section titled “Description”Unauthorized
get.responses.401.content?
Section titled “get.responses.401.content?”
optionalcontent?:undefined
get.responses.401.headers
Section titled “get.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.403
Section titled “get.responses.403”403:
object
Description
Section titled “Description”Forbidden
get.responses.403.content?
Section titled “get.responses.403.content?”
optionalcontent?:undefined
get.responses.403.headers
Section titled “get.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.404
Section titled “get.responses.404”404:
object
Description
Section titled “Description”Not found
get.responses.404.content?
Section titled “get.responses.404.content?”
optionalcontent?:undefined
get.responses.404.headers
Section titled “get.responses.404.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.500
Section titled “get.responses.500”500:
object
Description
Section titled “Description”Internal server error
get.responses.500.content?
Section titled “get.responses.500.content?”
optionalcontent?:undefined
get.responses.500.headers
Section titled “get.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/fields/{id}
Section titled “/v1/fields/{id}”/v1/fields/{id}:
object
Defined in: src/fields/types.gen.ts:79
delete
Section titled “delete”delete:
object
Delete a custom field
Description
Section titled “Description”Delete a custom field by Brex ID
delete.parameters
Section titled “delete.parameters”parameters:
object
delete.parameters.cookie?
Section titled “delete.parameters.cookie?”
optionalcookie?:undefined
delete.parameters.header?
Section titled “delete.parameters.header?”
optionalheader?:undefined
delete.parameters.path
Section titled “delete.parameters.path”path:
object
delete.parameters.path.id
Section titled “delete.parameters.path.id”id:
string
Description
Section titled “Description”The Brex identifier of the field to delete
Example
Section titled “Example”extended_field_foobardelete.parameters.query?
Section titled “delete.parameters.query?”
optionalquery?:undefined
delete.requestBody?
Section titled “delete.requestBody?”
optionalrequestBody?:undefined
delete.responses
Section titled “delete.responses”responses:
object
delete.responses.200
Section titled “delete.responses.200”200:
object
Description
Section titled “Description”Delete custom field response
delete.responses.200.content?
Section titled “delete.responses.200.content?”
optionalcontent?:undefined
delete.responses.200.headers
Section titled “delete.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
delete.responses.400
Section titled “delete.responses.400”400:
object
Description
Section titled “Description”Bad request
delete.responses.400.content?
Section titled “delete.responses.400.content?”
optionalcontent?:undefined
delete.responses.400.headers
Section titled “delete.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
delete.responses.401
Section titled “delete.responses.401”401:
object
Description
Section titled “Description”Unauthorized
delete.responses.401.content?
Section titled “delete.responses.401.content?”
optionalcontent?:undefined
delete.responses.401.headers
Section titled “delete.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
delete.responses.403
Section titled “delete.responses.403”403:
object
Description
Section titled “Description”Forbidden
delete.responses.403.content?
Section titled “delete.responses.403.content?”
optionalcontent?:undefined
delete.responses.403.headers
Section titled “delete.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
delete.responses.404
Section titled “delete.responses.404”404:
object
Description
Section titled “Description”Not found
delete.responses.404.content?
Section titled “delete.responses.404.content?”
optionalcontent?:undefined
delete.responses.404.headers
Section titled “delete.responses.404.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
delete.responses.500
Section titled “delete.responses.500”500:
object
Description
Section titled “Description”Internal server error
delete.responses.500.content?
Section titled “delete.responses.500.content?”
optionalcontent?:undefined
delete.responses.500.headers
Section titled “delete.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get:
object
Get custom field
Description
Section titled “Description”Get a custom field by Brex ID
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path
Section titled “get.parameters.path”path:
object
get.parameters.path.id
Section titled “get.parameters.path.id”id:
string
Description
Section titled “Description”The Brex identifier of the field to retrieve
Example
Section titled “Example”extended_field_foobarget.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:undefined
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”Get custom field response
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.brex_id
Section titled “get.responses.200.content.application/json.brex_id”brex_id:
string
Description
Section titled “Description”The internal Brex ID of the field
Example
Section titled “Example”extended_field_foobarget.responses.200.content.application/json.group?
Section titled “get.responses.200.content.application/json.group?”
optionalgroup?:"TRAVEL"|"ACCOUNTING"|"USER"|"ERP"|null
get.responses.200.content.application/json.is_disabled
Section titled “get.responses.200.content.application/json.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.
get.responses.200.content.application/json.name
Section titled “get.responses.200.content.application/json.name”name:
string|null
Description
Section titled “Description”The name of the field
get.responses.200.content.application/json.remote_id?
Section titled “get.responses.200.content.application/json.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_barget.responses.200.content.application/json.updated_at
Section titled “get.responses.200.content.application/json.updated_at”updated_at:
string
Format: date-time
Description
Section titled “Description”The last updated timestamp of the field
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.400
Section titled “get.responses.400”400:
object
Description
Section titled “Description”Bad request
get.responses.400.content?
Section titled “get.responses.400.content?”
optionalcontent?:undefined
get.responses.400.headers
Section titled “get.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.401
Section titled “get.responses.401”401:
object
Description
Section titled “Description”Unauthorized
get.responses.401.content?
Section titled “get.responses.401.content?”
optionalcontent?:undefined
get.responses.401.headers
Section titled “get.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.403
Section titled “get.responses.403”403:
object
Description
Section titled “Description”Forbidden
get.responses.403.content?
Section titled “get.responses.403.content?”
optionalcontent?:undefined
get.responses.403.headers
Section titled “get.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.404
Section titled “get.responses.404”404:
object
Description
Section titled “Description”Not found
get.responses.404.content?
Section titled “get.responses.404.content?”
optionalcontent?:undefined
get.responses.404.headers
Section titled “get.responses.404.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.500
Section titled “get.responses.500”500:
object
Description
Section titled “Description”Internal server error
get.responses.500.content?
Section titled “get.responses.500.content?”
optionalcontent?:undefined
get.responses.500.headers
Section titled “get.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
put:
object
Update a custom field
Description
Section titled “Description”Update a field by ID
put.parameters
Section titled “put.parameters”parameters:
object
put.parameters.cookie?
Section titled “put.parameters.cookie?”
optionalcookie?:undefined
put.parameters.header?
Section titled “put.parameters.header?”
optionalheader?:undefined
put.parameters.path
Section titled “put.parameters.path”path:
object
put.parameters.path.id
Section titled “put.parameters.path.id”id:
string
Description
Section titled “Description”The Brex identifier of the field to update
Example
Section titled “Example”extended_field_foobarput.parameters.query?
Section titled “put.parameters.query?”
optionalquery?:undefined
put.requestBody
Section titled “put.requestBody”requestBody:
object
put.requestBody.content
Section titled “put.requestBody.content”content:
object
put.requestBody.content.application/json
Section titled “put.requestBody.content.application/json”application/json:
object
put.requestBody.content.application/json.is_disabled?
Section titled “put.requestBody.content.application/json.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.
put.requestBody.content.application/json.name?
Section titled “put.requestBody.content.application/json.name?”
optionalname?:string|null
Description
Section titled “Description”The name of the field
put.responses
Section titled “put.responses”responses:
object
put.responses.200
Section titled “put.responses.200”200:
object
Description
Section titled “Description”Update custom field response
put.responses.200.content
Section titled “put.responses.200.content”content:
object
put.responses.200.content.application/json
Section titled “put.responses.200.content.application/json”application/json:
object
put.responses.200.content.application/json.brex_id
Section titled “put.responses.200.content.application/json.brex_id”brex_id:
string
Description
Section titled “Description”The internal Brex ID of the field
Example
Section titled “Example”extended_field_foobarput.responses.200.content.application/json.group?
Section titled “put.responses.200.content.application/json.group?”
optionalgroup?:"TRAVEL"|"ACCOUNTING"|"USER"|"ERP"|null
put.responses.200.content.application/json.is_disabled
Section titled “put.responses.200.content.application/json.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.
put.responses.200.content.application/json.name
Section titled “put.responses.200.content.application/json.name”name:
string|null
Description
Section titled “Description”The name of the field
put.responses.200.content.application/json.remote_id?
Section titled “put.responses.200.content.application/json.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_barput.responses.200.content.application/json.updated_at
Section titled “put.responses.200.content.application/json.updated_at”updated_at:
string
Format: date-time
Description
Section titled “Description”The last updated timestamp of the field
put.responses.200.headers
Section titled “put.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
put.responses.400
Section titled “put.responses.400”400:
object
Description
Section titled “Description”Bad request
put.responses.400.content?
Section titled “put.responses.400.content?”
optionalcontent?:undefined
put.responses.400.headers
Section titled “put.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
put.responses.401
Section titled “put.responses.401”401:
object
Description
Section titled “Description”Unauthorized
put.responses.401.content?
Section titled “put.responses.401.content?”
optionalcontent?:undefined
put.responses.401.headers
Section titled “put.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
put.responses.403
Section titled “put.responses.403”403:
object
Description
Section titled “Description”Forbidden
put.responses.403.content?
Section titled “put.responses.403.content?”
optionalcontent?:undefined
put.responses.403.headers
Section titled “put.responses.403.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
put.responses.404
Section titled “put.responses.404”404:
object
Description
Section titled “Description”Not found
put.responses.404.content?
Section titled “put.responses.404.content?”
optionalcontent?:undefined
put.responses.404.headers
Section titled “put.responses.404.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
put.responses.500
Section titled “put.responses.500”500:
object
Description
Section titled “Description”Internal server error
put.responses.500.content?
Section titled “put.responses.500.content?”
optionalcontent?:undefined
put.responses.500.headers
Section titled “put.responses.500.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
trace?
Section titled “trace?”
optionaltrace?:undefined