CustField

A custom field [CustField] is a field defined for a specific SuiteProjects Pro account and for a specific record type to suit the company business requirements. Custom field may also be created automatically or manually to support optional features in SuiteProjects Pro.

—	XML	SOAP	REST	Database table
Object	`CustField`	`oaCustField`	—	`cust_field`
Supported Commands	`Read`, `Modify`	`read()`, `modify()`	—	—

—

XML

SOAP

REST

Database table

Object

CustField

oaCustField

—

cust_field

Supported Commands

Read, Modify

read(), modify()

—

The CustField object has the following properties:

XML / SOAP	Database	Description
`active`	`active`	[Read-only] A 1/0 field indicating if this alert is active.
`association`	`association`	[Read-only] The table or object type this field is associated with. See Record Types and Forms Supporting Custom Fields for a list of associations.
`checked`	`checked`	[Read-only] A "1/0" field indicating if checkbox field is on by default
`created`	`created`	[Read-only] Time the record was created. See Date Fields.
`decpos`	`decpos`	[Read-only] The decimal size of the field.
`defnow`	`defnow`	[Read-only] A 1/0 field indicating if date fields default to today.
`description`	`description`	[Read-only] The description of the custom field.
`divider`	`divider`	[Read-only] A 1/0 field indicating whether to paint a divider.
`divider_text`	`divider_text`	[Read-only] Optional divider text.
`force_unique`	`force_unique`	[Read-only] A 1/0 field indicating if this field is unique.
`hidden_data_entry`	`hidden_data_entry`	[Read-only] A 1/0 field indicating whether the custom field should be hidden on the data entry UI.
`hint`	`hint`	[Read-only] The hint used on forms.
`id`	`id`	[Read-only] Unique ID. Automatically assigned by SuiteProjects Pro.
`maxlength`	`maxlength`	[Read-only] The maximum length of data in the field.
`mover`	`mover`	[Read-only] A 1/0 field indicating if the selector should have mover controls.
`name`	`name`	[Read-only] The name of the custom field.
`never_copy`	`never_copy`	[Read-only] A 1/0 field indicating if the field can be cloned.
`next_seq`	`next_seq`	[Read-only] Next sequence number to use.
`pick_source`	`pick_source`	[Read-only] Picker source. For example: user, customer, etc.
`picker`	`picker`	[Read-only] The type of field for on-screen representation: numeric, currency, date, text, textarea, check, radio, drop down, drop text, selector, or alloc_gr.
`required`	`required`	[Read-only] A 1/0 field indicating if this field is required.
`rows`	`rows`	[Read-only] The number of display rows for text area fields
`seq`	`seq`	[Read-only] The sequence number of the field.
`size`	`size`	[Read-only] The display size of the field on forms.
`title`	`title`	[Read-only] The title used on forms with this custom field.
`updated`	`updated`	[Read-only] Time the record was last updated or modified. See Date Fields.
`url`	`url`	[Read-only] Default url for url custom fields
`userid`	`user_id`	[Read-only] The ID of the user who created or owns this custom field.
`valuelist`	`valuelist`	A list of values for radio groups and popup menu fields in csv format.

XML / SOAP

Database

Description

active

[Read-only] A 1/0 field indicating if this alert is active.

association

[Read-only] The table or object type this field is associated with. See Record Types and Forms Supporting Custom Fields for a list of associations.

checked

[Read-only] A "1/0" field indicating if checkbox field is on by default

created

[Read-only] Time the record was created. See Date Fields.

decpos

[Read-only] The decimal size of the field.

defnow

[Read-only] A 1/0 field indicating if date fields default to today.

description

[Read-only] The description of the custom field.

divider

[Read-only] A 1/0 field indicating whether to paint a divider.

divider_text

[Read-only] Optional divider text.

force_unique

[Read-only] A 1/0 field indicating if this field is unique.

hidden_data_entry

[Read-only] A 1/0 field indicating whether the custom field should be hidden on the data entry UI.

hint

[Read-only] The hint used on forms.

id

[Read-only] Unique ID. Automatically assigned by SuiteProjects Pro.

maxlength

[Read-only] The maximum length of data in the field.

mover

[Read-only] A 1/0 field indicating if the selector should have mover controls.

name

[Read-only] The name of the custom field.

never_copy

[Read-only] A 1/0 field indicating if the field can be cloned.

next_seq

[Read-only] Next sequence number to use.

pick_source

[Read-only] Picker source. For example: user, customer, etc.

picker

[Read-only] The type of field for on-screen representation: numeric, currency, date, text, textarea, check, radio, drop down, drop text, selector, or alloc_gr.

required

[Read-only] A 1/0 field indicating if this field is required.

rows

[Read-only] The number of display rows for text area fields

seq

[Read-only] The sequence number of the field.

size

[Read-only] The display size of the field on forms.

title

[Read-only] The title used on forms with this custom field.

updated

[Read-only] Time the record was last updated or modified. See Date Fields.

url

[Read-only] Default url for url custom fields

userid

user_id

[Read-only] The ID of the user who created or owns this custom field.

valuelist

A list of values for radio groups and popup menu fields in csv format.