This release is scheduled to go 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 REST 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
, orRootOnly
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
, orRootOnly
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 isVisibility
. - In previous releases, the value returned for the
<DESCRIPTION>
property was null. Starting with 2025 R1, the value returned for the<DESCRIPTION>
property isVisibility
. - In previous releases, the value returned for the
<DATATYPE>
property wasTEXT
. Starting with 2025 R1, the value returned for the<DATATYPE>
property isENUM
.
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
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 REST 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
, orRootOnly
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
, orRootOnly
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 isVisibility
. - In previous releases, the value returned for the
<DESCRIPTION>
property was null. Starting with 2025 R1, the value returned for the<DESCRIPTION>
property isVisibility
. - In previous releases, the value returned for the
<DATATYPE>
property was TEXT. Starting with 2025 R1, the value returned for the<DATATYPE>
property isENUM
.
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.
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
, andinspect
functions now includeCOMPLIANCERECORDCUSTOMFIELDS
.
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