Currency Field API

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

Use this page to add a currency field to template XML. Assign the field to a role with roleId, then reuse the same field name in envelope requests.

Currency field example

<field
    type="money"
    name="contract_price"
    placeholder="Enter amount"
    roleId="fd8cb669-db1d-41e1-8f6c-2ad3f8fa981a"
    optional="false"
    search="true"
    formatting="true"
    min="0"
    max="999999"
/>

Required attributes

• type — field type. Use money.

• name — field name. Use 1 to 128 characters. Do not use &, ", <, or >. Keep the value unique within one document.

• roleId — role identifier for the recipient who fills the field.

Optional attributes

• placeholder — placeholder text shown in the template and envelope. Use 0 to 1024 characters. If you omit it, the envelope shows the field name.

• optional — set to true if the recipient can leave the field empty. If you omit it, the default value is false.

• search — set to true if the field value should be available in envelope search. If you omit it, the default value is false.

• formatting — set to true to display the value in the user's local number format.

• min — minimum numeric value allowed in the field.

• max — maximum numeric value allowed in the field.

Fixed behavior

• precision is always 2.

• trailingZeros is always true.

• Do not set precision or trailingZeros manually for this field type.

Validation rules

• min and max support values from -999999999999999 to 999999999999999.

Related topics

• Template Dynamic Fields API

• Template Structure API

• Send Envelope

• Fill Envelope