Number Field API

This document contains the Number field API format and a list of supported attributes.

Number field
<field type=”number” name=”string” placeholder=”string” roleId=”id” optional=”boolean” search=”boolean” formatting=”boolean” trailingZeros=”boolean” precision=”integer” min=”integer” max=”integer”/>

Number Field attributes

• type — define if this field is number type, mandatory attribute.

• name — string, length from 1 up to 128 symbols, restricted symbols &, “, <, >, field name used to fill in on envelope, unique for document, mandatory attribute.

• placeholder — field placeholder displayable on template and envelope, length from 0 up to 1024 symbols, if empty on envelope will be displayed field name, optional attribute.

• roleId — id of the role who should fill field on envelope, mandatory attribute.

• optional — boolean, defines if field to be filled in optionally or not on envelope, if not set default value false, optional attribute.

• search — boolean, defines if field is searchable on envelope search or not, if not set default value false, optional attribute.

• formatting — boolean, defines conversion of field data to on UI to local format set up in User profile, optional attribute.

• trailingZeros — boolean, defines how to show decimal zeros after field completion, available only with precision value, optional attribute.

• precision — integer, defines quantity of decimal numbers allowed, allowed value range from 0 to 7, default value empty, optional attribute.

• min — integer, allowed values range from -999999999999999 to 999999999999999, define minimal value has to be entered to field become valid, default value empty, optional attribute.

• max — integer, allowed values range from -999999999999999 to 999999999999999, define maximal value allowed in field to be valid, default value empty, optional attribute.