Download OpenAPI specification:Download
The Fields API allows you to manage fields and field values information.
List custom fields under the same account
List custom fields response
Bad request
Unauthorized
Forbidden
Internal server error
{- "next_cursor": "string",
- "items": [
- {
- "brex_id": "extended_field_foobar",
- "name": "string",
- "remote_id": "foo_bar",
- "updated_at": "2019-08-24T14:15:22Z",
- "is_disabled": true,
- "group": "ACCOUNTING"
}
]
}
Create a custom field
Create custom field response
Bad request
Unauthorized
Forbidden
Not found
Internal server error
{- "name": "string",
- "group": "ACCOUNTING",
- "remote_id": "foo_bar",
- "is_disabled": true
}
{- "brex_id": "extended_field_foobar",
- "name": "string",
- "remote_id": "foo_bar",
- "updated_at": "2019-08-24T14:15:22Z",
- "is_disabled": true,
- "group": "ACCOUNTING"
}
Get a custom field by Brex ID
Get custom field response
Bad request
Unauthorized
Forbidden
Not found
Internal server error
{- "brex_id": "extended_field_foobar",
- "name": "string",
- "remote_id": "foo_bar",
- "updated_at": "2019-08-24T14:15:22Z",
- "is_disabled": true,
- "group": "ACCOUNTING"
}
Update a field by ID
Update custom field response
Bad request
Unauthorized
Forbidden
Not found
Internal server error
{- "name": "string",
- "is_disabled": true
}
{- "brex_id": "extended_field_foobar",
- "name": "string",
- "remote_id": "foo_bar",
- "updated_at": "2019-08-24T14:15:22Z",
- "is_disabled": true,
- "group": "ACCOUNTING"
}
List values under the same custom field
List custom field values response
Bad request
Unauthorized
Forbidden
Internal server error
{- "next_cursor": "string",
- "items": [
- {
- "brex_id": "efo_foobar",
- "remote_id": "foo_bar",
- "value_id": "foo_bar",
- "value": "string",
- "field_id": "extended_field_foobar",
- "updated_at": "2019-08-24T14:15:22Z",
- "is_disabled": true
}
]
}
Update custom field values (up to 1000 values at once) for a specific field
required | Array of by `brex_id` (object) or by `value_id` (object) or by `remote_id` (object) (Field value to update) [ 1 .. 1000 ] properties The field values to update (1000 items max) |
Update custom field value list response
Bad request
Unauthorized
Forbidden
Not found
Internal server error
{- "items": [
- {
- "brex_id": "efo_foobar",
- "data": {
- "value": "string",
- "is_disabled": true
}
}
]
}
{- "items": [
- {
- "brex_id": "efo_foobar",
- "remote_id": "foo_bar",
- "value_id": "foo_bar",
- "value": "string",
- "field_id": "extended_field_foobar",
- "updated_at": "2019-08-24T14:15:22Z",
- "is_disabled": true
}
]
}
Create custom field values (up to 1000 values at once) for a specific field
required | Array of objects (Field value creation) non-empty The list of field values to be created |
Create custom field values response
Bad request
Unauthorized
Forbidden
Not found
Internal server error
{- "items": [
- {
- "value": "string",
- "value_id": "FooBar",
- "remote_id": "foo_bar",
- "is_disabled": true
}
]
}
{- "items": [
- {
- "brex_id": "efo_foobar",
- "remote_id": "foo_bar",
- "value_id": "foo_bar",
- "value": "string",
- "field_id": "extended_field_foobar",
- "updated_at": "2019-08-24T14:15:22Z",
- "is_disabled": true
}
]
}
Delete custom field values (up to 1000 values at once) for a specific field
required | Array of by `brex_id` (object) or by `value_id` (object) or by `remote_id` (object) (Field value to delete) [ 1 .. 1000 ] properties The field values to delete (1000 items max). |
Delete custom field value list response
Bad request
Unauthorized
Forbidden
Not found
Internal server error
{- "items": [
- {
- "brex_id": "efo_foobar"
}
]
}
{ }
Get a field value by field ID and field value ID
Get a field value response
Bad request
Unauthorized
Forbidden
Not found
Internal server error
{- "brex_id": "efo_foobar",
- "remote_id": "foo_bar",
- "value_id": "foo_bar",
- "value": "string",
- "field_id": "extended_field_foobar",
- "updated_at": "2019-08-24T14:15:22Z",
- "is_disabled": true
}