Xentral icon

Xentral

Interact with Xentral ERP API

Actions196

Credit Note → Set Write Protection

AI-generated

Summary

Set write protection on a specified credit note in Xentral, making it immutable or locked for further editing via the API.

Inputs

  • Credit Note ID (required) — The unique identifier of the credit note to apply write protection to.
  • Max Pages — Limits the maximum number of API pages to fetch when returning multiple records; applicable only when retrieving all records with returnAll set to true. Defaults to 1000 pages.

Output shape

a single updated credit note record, confirming that write protection has been applied

The operation requires the Credit Note ID as input and returns the updated credit note. Max Pages parameter affects only bulk fetch operations and is not applicable to this single update operation. Error handling follows Xentral API conventions.

Examples

Example 1: Applying write protection to credit note with ID '12345' to prevent further modifications.

Provide '12345' as Credit Note ID. Max Pages is unused.

Links

Discussion