Order

{
  "id": "69eb125feddfff1d13676751",
  "status": "approved",
  "employee": "68a000000000000000000001",
  "orderNumber": 10495,
  "createdAt": "2026-07-01T10:00:00.000Z",
  "updatedAt": "2026-07-02T12:15:00.000Z",
  "products": [
    {
      "id": "69eb125feddfff1d13676761",
      "label": "Example Smartphone, 256 GB, Black, New",
      "model": "Example Smartphone",
      "vatRate": "19.00",
      "manufacturerName": "Example Manufacturer",
      "articleGroupName": "smartphones",
      "grossAmount": "34.99",
      "netAmount": "29.4034",
      "service": false,
      "grossService": null,
      "netService": null,
      "isAccessory": false
    },
    {
      "id": "69eb125feddfff1d13676762",
      "label": "Example Protective Case",
      "model": "Example Protective Case",
      "vatRate": "19.00",
      "manufacturerName": "Example Manufacturer",
      "articleGroupName": "accessories",
      "grossAmount": "3.99",
      "netAmount": "3.3529",
      "service": null,
      "grossService": null,
      "netService": null,
      "isAccessory": true
    }
  ],
  "deliveryAddress": {
    "firstName": "Alex",
    "lastName": "Morgan",
    "street": "Example Street 12",
    "postalCode": "50667",
    "city": "Cologne",
    "countryCode": "DE"
  },
  "contractDurationInMonths": 24,
  "contractStartDate": "2026-08-01T00:00:00.000Z",
  "contractEndDate": "2028-07-31T23:59:59.999Z",
  "attachments": [
    {
      "id": "contract.10495.1",
      "type": "nuev"
    },
    {
      "id": "contract.10495.2",
      "type": "emv"
    }
  ],
  "hrHistory": {
    "approvedBy": null,
    "approvedAt": "2026-07-02T12:15:00.000Z",
    "rejectedBy": null,
    "rejectedAt": null,
    "requestedAt": "2026-07-01T10:00:00.000Z",
    "decisionBy": null
  }
}

The schema below is rendered directly from the published OpenAPI 3.1 contract.

Order details.

string

required

read-only

Unique order identifier.

Pattern: ^[0-9a-fA-F]{24}$

Example:

"69eb125feddfff1d13676751"

status

enum<string>

required

read-only

Current order lifecycle status. Values are case-sensitive.

Available options:

under_review,

rejected,

approved,

active,

archived,

withdrawn

Minimum string length: 1

Example:

"approved"

employee

string

required

Identifier of the employee who placed or owns the order.

Pattern: ^[0-9a-fA-F]{24}$

Example:

"68a000000000000000000001"

orderNumber

integer

required

read-only

Human-readable numeric order number.

Must be a multiple of 1

Example:

10495

createdAt

string<date-time>

required

read-only

UTC timestamp at which the order was created.

Minimum string length: 1

Pattern: Z$

Example:

"2026-07-01T10:00:00.000Z"

updatedAt

string<date-time>

required

read-only

UTC timestamp of the latest order update.

Minimum string length: 1

Pattern: Z$

Example:

"2026-07-02T12:15:00.000Z"

products

object[]

required

Products and accessories included in the order.

Show child attributes

deliveryAddress

object | null

required

nullable

Delivery address for the order, or null when no delivery address is available.

Show child attributes

Example:

{
  "firstName": "Alex",
  "lastName": "Morgan",
  "street": "Example Street 12",
  "postalCode": "50667",
  "city": "Cologne",
  "countryCode": "DE"
}

hrHistory

object

required

HR review request and decision history.

Show child attributes

Example:

{
  "approvedBy": null,
  "approvedAt": "2026-07-02T12:15:00.000Z",
  "rejectedBy": null,
  "rejectedAt": null,
  "requestedAt": "2026-07-01T10:05:00.000Z",
  "decisionBy": null
}

contractDurationInMonths

number | null

required

nullable

Contract duration in whole months, or null when not determined.

Must be a multiple of 1

Example:

24

contractStartDate

string<date-time> | null

required

nullable

UTC contract start date, or null when not determined.

Minimum string length: 1

Pattern: Z$

Example:

"2026-08-01T00:00:00.000Z"

contractEndDate

string<date-time> | null

required

nullable

UTC contract end date, or null when not determined.

Minimum string length: 1

Pattern: Z$

Example:

"2028-07-31T23:59:59.999Z"

attachments

object[]

required

Order contract documents available through the order attachment download endpoint.

Show child attributes

Last modified on August 26, 2026

Overview

Data Models

Specification