Update Operations

ERP.net supports updating entities using the PATCH method, which performs partial updates.
Only the fields included in the request are modified; all other properties remain unchanged (except dependent properties updated by business rules triggered on attribute change).

Key Points:

Use PATCH to modify one or more fields of an existing entity.
You do not need to send the entire entity.
Always consider property dependencies when updating complex fields such as Quantity and Amount. Depending on the entity structure, the unit or currency code inside the complex value may either resolve the dependent reference automatically or be required to match an already effective reference. See Property Dependencies and Update Order.
Business rules and validations defined in the front-end or back-end models will be applied depending on how the data is processed.
ERP.net supports optimistic locking to prevent conflicts during concurrent updates. Learn more in Optimistic Locking.

Example: Updating the notes of a sales order:

PATCH https://testdb.my.erp.net/api/domain/odata/Crm_Sales_SalesOrders(f3fe442a-d5fe-49a9-8bda-00c895d630bb)
Content-Type: application/json

{
    "DocumentNotes": "Updated sales order description"
}

Example: Updating a product (including dependent complex fields):

PATCH https://testdb.my.erp.net/api/domain/odata/General_Products_...1-478f-91c2-f5520590f534) 
Content-Type: application/json

{ 
    "ABCClass": "A", 
    "MeasurementUnit@odata.bind": "https://testdb.my.erp.net/api/domain/odata/General_Measureme...b-4338-abd0-3a2acb27ff93)",
    "StandardLotSizeBase": { "Value": 3.45, "Unit": "pcs" }
}

Note

When updating complex fields such as Quantity and Amount, the behavior depends on where the dependent measurement unit or currency is stored. If it is stored in the same entity, ERP.net can resolve and assign it automatically from the code in the complex value. If it is stored outside the entity, the code in the complex value must match the already effective reference. See Property Dependencies and Update Order.

Required Considerations:

If updating fields involved in calculations or triggers, ensure dependent properties are included in the correct order.
Only include fields you intend to modify; others will remain unchanged.
System and user business rules will execute as appropriate (front-end rules on attribute changes, back-end rules on commit or document events).

For more details on entity properties and rules, refer to the documentation of each entity. Foe example Sales Orders Documentation.

Notes For concurrency control and optimistic locking see Data Sync topic.

Table of Contents

Update Operations

Note