Sign in

v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Custom Field

Get a custom field.

get/api/custom-fields/{id}

Path parameters

idstring required

Response

The custom field for the given id

idstring required

Unique id associated to this entity.

namestring required

Identifying name. Must be unique.

labelstring required

Label name. Must be unique and cannot contain spaces.

type'text' | 'multilineText' | 'dropdown' | 'multipleChoiceDropdown' | 'integerNumber' | 'decimalNumber' | 'floatingPointNumber' | 'boolean' | 'list' | 'date' | 'multipleChoiceUser' required
module'item' | 'item_Make' | 'item_Buy' | 'customer' | 'vendor' | 'quote' | 'sales_Order' | 'job' | 'invoice' | 'purchase_Order' | 'receive_Order' | 'ship_Order' | 'quote_Part_LineItem' | 'sales_Order_Part_LineItem' | 'purchase_Order_Part_LineItem' | 'outsideProcessing_LineItem' | 'shipping_Part_LineItem' | 'invoice_Part_LineItem' | 'job_Operation' | 'ncr' | 'capa' required
requiredboolean required

Required.

optionsstring[] nullable

The options available (only applicable to dropdown and multiplechoicedropdown types).

prependstring nullable

Prepended text.

appendstring nullable

Appended text.

helpTextstring nullable

Help information that will be visble to the user.