Developer Documentation: New Topics

In MYOB Acumatica 2024.1, a developer can find new and reworked guides, as described in the following sections.

API Reference

API Reference has been reworked as follows:

• In previous versions, the API elements were grouped by assemblies. Now the elements are grouped by namespaces (see Item 1 in the following screenshot).
• All members of an element are now described on one page (Item 2). (Previously, the reference included separate pages for each member.)

Topics from T Courses

Now the topics from the T240 Processing Forms and T250 Inquiry Forms courses are available in the developer documentation. The developer can review the following chapters:

• Preparing a Test Instance for Customization
• Replacing Attributes for DAC Fields in CacheAttached
• Defining the External and Internal Presentation of Field Values
• Setting Up Inquiry Forms
• Creating Processing Forms
• Adding Filtering Parameters to a Form
• Filtering Records Dynamically with Data View Delegates
• Aggregating Data
• Displaying Data from Multiple DACs by Using PXProjection
• Redirecting the User to Webpages
• Updating Data with a Custom PXAccumulator Attribute

New and Updated REST API Examples

In the Integration Development Guide, REST API examples have been added or updated for the following entities:

• Basic requests:
  • Retrieve Records Filtered by Custom Fields
  • Retrieve Localized Values of a Multilingual Field
  • Retrieve Localized Values of All Multilingual Fields
  • Request a Report
• Bill: Release Retainage
• SalesInvoice:
  • Remove a Sales Invoice from Hold
  • Invoke Release of an Invoice
  • Retrieve the Status of the Release Operation
  • Check the Status of the Sales Invoice
• SalesOrder: Retrieve a Sales Order with Detail Lines
• StockItem: Retrieve the List of Attachments of a Stock Item

Modern UI Guides

Two new developer guides, which are shown in the following screenshot, are now available for the Modern UI:

• UI Developer Guide: In this guide, a developer can find information about how to create the Modern UI for an MYOB Acumatica Framework–based application. The developer will learn how to configure the development environment and how to design the layout of a form.
• UI Component Reference Guide: In this guide, the developer can find details about configuration of UI components. For each UI component, the developer can find the design guidelines, naming conventions, and API reference information.

New Information in the MYOB Acumatica Framework Guide and Customization Guide

Based on the feedback that we have received from developers, we have created or updated the following topics in the MYOB Acumatica Framework Guide and Customization Guide:

• Managing Customization Projects by Using the PX.CommandLine Tool
• Naming Conventions for Tables (DACs) and Columns (Fields)
• Preservation of Deleted Records (DeletedDatabaseRecord)
• Putting a Sales Order on Credit Hold Status Programmatically
• Implementing the XML Import and Export Functionality in a Custom Form