2025 Release 1

This release went live on February 7, 2025.

Accounts Payable

The following changes are being introduced for the VENDOR and VENDORVISIBILITY objects. To learn more about the functions that are changing, see Vendors in the XML API Reference.

VENDOR read function

  • In previous releases, by default the legacy read function returned a value of null for the visibility_type field. Starting with the 2025 R1 release, the legacy read function returns a value of Restricted, Unrestricted, or RootOnly for the visibility_type field to report the actual setting for this field.
  • In previous releases, by default the read function returned a value of null for the OBJECTRESTRICTION field. Starting with the 2025 R1 release, the read operation returns a value of Restricted, Unrestricted, or RootOnly for the OBJECTRESTRICTION field to report the actual setting for this field.

VENDOR lookup function

The data returned for the OBJECTRESTRICTION field has changed:

  • In previous releases, the value returned for the <LABEL> property was null. Starting with 2025 R1, the value returned for the <LABEL> property is Visibility.
  • In previous releases, the value returned for the <DESCRIPTION> property was null. Starting with 2025 R1, the value returned for the <DESCRIPTION> property is Visibility.
  • In previous releases, the value returned for the <DATATYPE> property was TEXT. Starting with 2025 R1, the value returned for the <DATATYPE> property is ENUM.

VENDORVISIBILITY read function

Starting in the 2025 R1 release:

  • The RESTRICTEDLOCATIONS and RESTRICTEDDEPARTMENTS fields are being removed from entity objects and moved to owned objects of each entity.
  • Several new fields have been added to capture data about owning entities, including MEGAENTITYKEY, MEGAENTITYID, and MEGAENTITYNAME.

Accounts Receivable

Customer bank account to be deprecated

As part of the initiative to minimize the auditing burden that comes with handling sensitive data, the legacy customer bank account object will be deprecated and unavailable for use starting in 2025 Release 4.

Anyone using the legacy customer bank account object should plan for its deprecation. The object and all its supported operations, documented in the Customer Bank Accounts API reference content, will no longer be available after November 7, 2025.

Customer and customer visibility objects

The following changes are being introduced for the CUSTOMER and CUSTOMERVISIBILITY objects. To learn more about the functions that are changing, see Customers in the XML API Reference.

CUSTOMER read function

  • In previous releases, by default the legacy read function returned a value of null for the visibility_type field. Starting with the 2025 R1 release, the legacy read function returns a value of Restricted, Unrestricted, or RootOnly for the visibility_type field to report the actual setting for this field.
  • In previous releases, by default the read function returned a value of null for the OBJECTRESTRICTION field. Starting with the 2025 R1 release, the read operation returns a value of Restricted, Unrestricted, or RootOnly for the OBJECTRESTRICTION field to report the actual setting for this field.

CUSTOMER lookup function

The data returned for the OBJECTRESTRICTION field has changed:

  • In previous releases, the value returned for the <LABEL> property was null. Starting with 2025 R1, the value returned for the <LABEL> property is Visibility.
  • In previous releases, the value returned for the <DESCRIPTION> property was null. Starting with 2025 R1, the value returned for the <DESCRIPTION> property is Visibility.
  • In previous releases, the value returned for the <DATATYPE> property was TEXT. Starting with 2025 R1, the value returned for the <DATATYPE> property is ENUM.

CUSTOMERVISIBILITY lookup function

Starting in the 2025 R1 release:

  • The RESTRICTEDLOCATIONS and RESTRICTEDDEPARTMENTS fields are being removed from entity objects and moved to owned objects of each entity.
  • Several new fields have been added to capture data about owning entities, including MEGAENTITYKEY, MEGAENTITYID, and MEGAENTITYNAME.

CUSTOMERVISIBILITY read function

Starting in the 2025 R1 release:

  • The RESTRICTEDLOCATIONS and RESTRICTEDDEPARTMENTS fields are no longer returned with this function.
  • A new MEGAENTITYNAME field is returned with this function.

Cash Management

New fund transfers fields - Early adopter enhanced currency support

For global companies configured to use enhanced currency support, which is available for early adopters in the 2025 R1 release, the following new fields are returned in results for FUNDSTRANSFER lookup and read functions. Note that the new Enable Multi-Currency Funds Transfer feature flag must be enabled to use enhanced currency support.

  • FROM_ACCOUNT_TRX_AMOUNT
  • FROM_ACCOUNT_BASE_CURRENCY
  • FROM_ACCOUNT_AMOUNT
  • FROM_ACCOUNT_EXCH_RATE_TYPE_ID
  • FROM_ACCOUNT_EXCHANGE_RATE
  • FROM_ACCOUNT_EXCH_RATE_DATE

For more information about the FUNDSTRANSFER object, see Fund Transfers in the API Reference.

Purchasing

Use custom fields for compliance objects

Custom fields give you a way to capture business-specific data. Compliance types provide a way to specify which custom fields are applicable to the type of compliance record used. Now when you query on the COMPLIANCETYPE object, you can see a COMPLIANCERECORDCUSTOMFIELDS field. For example:

<query>
    <object>COMPLIANCETYPE</object>
    <select>
        <field>RECORDNO</field>
        <field>COMPLIANCETYPEID</field>
        <field>NAME</field>
        <field>STATUS</field>
        <field>COMPLIANCERECORDCUSTOMFIELDS</field>
    </select>
    <filter>
        <equalto>
            <field>STATUS</field>
            <value>active</value>
        </equalto>
    </filter>
</query>

The COMPLIANCERECORD object remains unchanged. Note that custom fields must be added to compliance records through the user interface before being used by compliance types. From the main menu in your company, go to Platform Services or Customization Services > All > Custom Fields to add custom fields to compliance records. Expected behaviors, such as errors returned when required custom fields are not included, apply. In addition:

  • The delete function is not affected by this change.
  • The read, readbyname, query, readbyquery, lookup, and inspect functions now include COMPLIANCERECORDCUSTOMFIELDS.

For more information, see Vendor Compliance Types.

Construction

Specify entities as limited

The ENTITY object has a new ISLIMITEDENTITY Boolean field. The field is included in read and query responses. The default value is false.

Web Services

RECORDTYPE capitalization change

The capitalization of the RECORDTYPE value for some record types has been changed slightly. For example, the previous value of AR Advance is now returned as AR advance. This is the list of new record type values:

  • Quick invoice
  • AR invoice
  • AP bill
  • AR advance
  • AR discount
  • AR receipts
  • AR adjustments
  • AR realized multi-currency gain/loss
  • AP adjustment

Permission enhancement for AUDITHISTORY and ADVAUDITHISTORY

Permission requirements for the use of the AUDITHISTORY and ADVAUDITHISTORY objects in the API have been changed to match the requirements of the equivalent Audit Trail and Advanced Audit Trail features in the application. The user associated with the API session must have View permission for custom reports. That permission can be enabled under the Platform Services subscription.

Audit-related requests when the user does not have the right permission will return this error:

Unable to view audit history. You do not have permission to view audit history

Provide feedback