Customizing Address Forms

Custom address forms can be used to support address format localization for international customers, and unique business requirements for all customers. A standard address form is provided for all accounts and assigned by default to all countries. Account administrators and other users with the Custom Address Form permission can create as many customized versions of the address form as needed, and assign each custom address form to one or more countries.

When users view or edit addresses on entity, transaction, subsidiary, company information, location, and workplace records, the custom address form assigned to the selected country is the one that displays in the popup address window. Custom address forms inherit the permissions set on the parent record.

Custom address forms support the following capabilities:

To create a custom address form:

  1. Go to Customization > Forms > Address Forms, and click Customize for the standard address form.

  2. In the body area of a custom address form record, you can define a name for the form, and modify the template representing how addresses are rendered in the user interface and on printed shipping labels.

    In the Address Template field, address fields are represented by the template field IDs listed on the Fields subtab.

  3. On the Fields subtab, you can:

    • Rearrange fields on the form, using the Move to Top and Move to Bottom buttons, and the Column Break, Space Before, and Same Row as Previous fields.

    • Hide fields by clearing the Show box.

      The Show box cannot be cleared for fields that are required.

    • Make fields required by checking the Mandatory box.


      The Country field is always required, because the value for this field determines the address form to be displayed.

    • Set fields’ display type to inline text or disabled.

    • Modify field labels.

    • Click the New Field button to add a custom field to the address form. For details, see Creating Custom Address Fields.

  4. On the Custom Code subtab, you can attach a script file containing functions for any of the supported SuiteScript client events.

    For information about creating scripts to be attached to custom forms, see SuiteScript 2.x Client Script Type.

  5. On the Country subtab, you can assign the custom address form to one or more countries.

    A multi-select list of countries is available when you click the icon to the right of the Country field on this subtab. For more information, see Country-Specific Address Forms.

  6. Click Save.

Change to Required Permission for Attaching Scripts to Custom Address Forms

Users who have the Custom Address Form permission, but who do not have the SuiteScript permission, can no longer access the Custom Code tab of custom forms. Previously, these users could edit the Custom Code tab of an address form record to attach a script to the form.

Now users must have at least the Edit level of the SuiteScript permission to attach a script to a custom form by editing the Custom Code tab of the form record. For users with the Edit or Full level of the SuiteScript permission, the Custom Code tab is displayed and is fully editable. Users with the View or Create level of the SuiteScript permission can see the Custom Code tab, but cannot edit it. For users who do not have SuiteScript permission, the Custom Code tab is not visible.

Related Topics

Custom Forms
Creating Custom Entry and Transaction Forms
Transaction Form Printing Preferences
Creating Custom Subtabs
Creating Custom Note Forms
Custom Sublists
Customizing a Transaction Sublist

General Notices