How to Add a Custom Field to the Sales Order Screen in Acumatica

How to add the field with a DAC extension

1. 1Open Customization > Customization Projects (SM204505), create a new project, and open it in the Customization Project Editor.
2. 2Go to Screens > Sales Orders (SO301000) > Layout Editor, or use Inspect Element (Ctrl+Alt+Click on the field area) to jump into the screen from the page.
3. 3In the Data Access (DAC) area, add a new DAC extension for SOOrder and add a field such as UsrCustomerPONote with the right type (string, length) and a display name.
4. 4Choose to add the field to the database so Acumatica creates the column on the SOOrder table and extension table during publish.
5. 5In the Layout Editor, drag the new field into the Order Summary section, set the label, and save the layout.
6. 6Publish the project, hard refresh the browser, and test with a new sales order to confirm the value saves and reloads.
7. 7If the field must flow to another document, such as a shipment or invoice, add a matching extension and handler (FieldDefaulting or RowPersisting) in a graph extension.
8. 8Export the project zip and commit it to source control so it can be promoted to test and production.

What the code looks like

public sealed class SOOrderExt : PXCacheExtension<SOOrder>
{
  public abstract class usrCustomerPONote : PX.Data.BQL.BqlString.Field<usrCustomerPONote> { }
  [PXDBString(100)]
  [PXUIField(DisplayName = "Customer PO Note")]
  public virtual string UsrCustomerPONote { get; set; }
}

Common pitfalls

• !Using Attributes for data that needs heavy reporting, then discovering Generic Inquiry joins are slow and awkward.
• !Forgetting the Usr prefix and clashing with a future platform field.
• !Adding the field to the layout but not to the database, which causes a runtime error on save.
• !Not exposing the field in the web service endpoint, so integrations cannot see it.
• !Skipping a test tenant publish before production.