Sign in

v1

latestOpenAPI 3.1.02026-08-065163115.0 KB
Custom Fields

Create a custom field

Creates a new custom field for the given business. The created_by value will be set to PUBLIC_API.

post/v1/businesses/{client_id}/custom-fields

Path parameters

client_idinteger required
Example:123

The ID of the business.

Request body

namestring required

The display name for the custom field. Must be unique within the business.

field_type'LIST' | 'FREE_TEXT' required

The type of the custom field.

budget_setting'NONE' | 'SOME' | 'ALL_CURRENT_AND_NEW'

Controls which budgets this custom field is assigned to.

Example request

{
  "name": "Project Code",
  "field_type": "LIST",
  "budget_setting": "NONE"
}

Response

Created

idstring uuid

The unique identifier for this custom field.

namestring

The display name of the custom field.

field_type'LIST' | 'FREE_TEXT'

The type of the custom field.

budget_setting'NONE' | 'SOME' | 'ALL_CURRENT_AND_NEW'

Controls which budgets this custom field is assigned to.

is_manager_onlyboolean

Whether this custom field is visible only to managers. Cannot be changed after creation.

created_by'MANUAL' | 'PUBLIC_API' | 'XERO' | 'MYOB' | 'QUICKBOOKS' | 'NETSUITE' | 'BUSINESS_CENTRAL'

The source that created this custom field.

createdstring date-time

The date and time when this custom field was created.

updatedstring date-time

The date and time when this custom field was last updated.

Example response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Project Code",
  "field_type": "LIST",
  "budget_setting": "NONE",
  "created_by": "PUBLIC_API",
  "created": "2024-01-15T09:00:00Z",
  "updated": "2024-01-15T09:00:00Z"
}