Field

Additional field model.

Name Type Description
data_type String Field value data type. Allowed values: string, int, decimal, bool.
entity_type String Entity the additional field is linked to. Allowed values: Default, RetailCustomer, Partner, DocPurchase, Item, DocPayment, DocAccountMovement, Task, Lead, Deal, Client, Ticket, User, OperatingCash.
id Int64 Field ID.
is_custom Boolean Indicates whether the field is custom (true) or system-defined (false).
key String Unique field key (machine name).
metadata String Field metadata. Optional field, up to 500 characters including escaping.
name String Human-readable field name.
required Boolean Indicates whether the field is required.