Skip to main content
Orders are read-only except for the dedicated HR decision operation.

​
Status values

Only under_review can be changed by the public decision operation, to approved or rejected.

​
Endpoints

List orders

Retrieve orders by status, employee, dates, and documented scalar fields. Use X-Tenant-ID to restrict the tenant context where required.

Get an order

Read products, contract fields, employee, status, and attachment references.

Approve or reject

Validate and apply one HR decision from under_review.

Download attachment

Download a contract document by attachment ID.

​
Order response model

The provider’s updated schema no longer returns tenant or divisionId inside an order. Tenant restriction remains available through X-Tenant-ID where the operation documents that header. HR review data is returned in hrHistory: hrHistory replaces the previous hrReviewDecision object. The old actor-category enum in decisionBy is no longer part of the provider schema.

​
Product response model

Each entry in products[] exposes product identity, classification, VAT, gross and net amounts, optional service amounts, and the accessory flag.
The current API version remains 1.0.0, but the order response shape has changed. Update generated clients, DTOs, deserializers, mappings, calculations, mocks, and contract tests before adopting the refreshed schema. Do not interpret the new decimal strings as integer cents.

​
Decision rules

  • Re-read the order immediately before deciding.
  • Use dry run before the real decision.
  • A final decision cannot be overwritten through the endpoint.
  • Approval applies documented contract-date defaults and corresponding notifications.
  • The contract does not enumerate notification recipients; do not depend on an undocumented list.
  • After a timeout, re-read the order before any replay.

Order processing guide

Follow the review swimlane, state checks, conflict handling, and timeout reconciliation.
Last modified on August 28, 2026