Operations

Service

Sellable line that does not come from inventory: personnel, transport, work days.

Schemas: ServiceDto

{
  "id": "id_8f2a1c",
  "name": "Example",
  "serviceType": "string",
  "description": "string",
  "defaultQty": 1,
  "showInPlanner": true,
  "includeInPrice": true,
  "collectionName": "Example",
  "tags": [
    {
      "id": "id_8f2a1c",
      "name": "Example"
    }
  ],
  "requirements": [
    {
      "requiredResourceType": "personnel",
      "qty": 1,
      "requiredTags": [
        "string"
      ]
    }
  ],
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}

Generated from the schema

A sellable line that does not come from inventory: personnel, transport or work days. A service says whether it shows in the planner and whether it is included in the price, and it can carry requirements. The cost of the service and its internal name are not published.

Attributes

idstring

Unique service identifier.

namestring

Service name as the customer sees it.

serviceTypestring

Type: crew (personnel), fleet (vehicles) or general.

descriptionstring | null

Description; null if it has none.

defaultQtyinteger

Quantity added to an order by default.

showInPlannerboolean

Whether it appears as a plannable service.

includeInPriceboolean

Whether its amount counts towards the document total.

collectionNamestring | null

Path of the collection it belongs to; null if it is in none.

tagsobject[]

Service tags, with their identifier and name.

Show child attributes

tags.idstring

Unique identifier of the tag.

tags.namestring

Tag name.

requirementsobject[]

Resources needed to provide it.

Show child attributes

requirements.requiredResourceTypestring

What is needed to provide it: personnel or vehicle.

Available options: personnel, vehicle

requirements.qtyinteger

How many are needed.

Limits: min 1

requirements.requiredTagsstring[]

Tags the assigned resource must have. E.g.: "Carné C".

Limits: max 20 items, each max length 100

createdAtstring<date-time> | null

Creation date in ISO 8601 UTC; null if not recorded.

updatedAtstring<date-time> | null

Last modification date in ISO 8601 UTC; null if not recorded.

Returned by

GET /api/v1/services — List services
GET /api/v1/services/{serviceId} — Get a service

Modified by

POST /api/v1/services — Create a service
PATCH /api/v1/services/{serviceId} — Update a service

Was this page helpful?