Xentral icon

Xentral

Interact with Xentral ERP API

Actions196

Return → Update

AI-generated

Summary

Update the details of an existing return order in Xentral by specifying its ID and providing any fields to modify.

Inputs

  • returnId (required) — The ID of the return order to update.
  • updateFields — A collection of fields to update on the return order, such as body introduction text, closing text, associated credit note ID, customer order number, delivery note ID, delivery terms, document address override, document date, editor ID, internal comments, language, progress status, project ID, related sales order IDs, print settings, sales representative ID, tags, VAT ID, and flags like whether it is a supplier return order.
  • maxPages — Maximum number of API pages to fetch when returning all, with each page having 50-150 records; used only when returnAll is true.

Output shape

a single updated return order record

The operation returns the updated return order object after applying the specified changes. Pagination controls like maxPages apply only if returnAll is used. Errors occur if the returnId is missing or invalid.

Links

Discussion