Operations

Repair ticket

Repair ticket: what broke and what is quoted to fix it.

Schemas: RepairTicketDto, RepairTicketDetailDto

{
  "id": "id_8f2a1c",
  "number": "string",
  "date": "2026-09-01T08:00:00Z",
  "status": "draft",
  "orderId": "string",
  "orderNumber": "string",
  "contactId": "string",
  "contactName": "Example",
  "subTotal": "1234.50",
  "taxTotal": "1234.50",
  "total": "1234.50",
  "totalLines": 1,
  "notes": "string",
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z",
  "projectId": "string",
  "lines": [
    {
      "id": "id_8f2a1c",
      "entityType": "item",
      "entityId": "string",
      "entityName": "Example",
      "description": "string",
      "diagnosis": "string",
      "quantity": 1,
      "unitPrice": "1234.50",
      "incidentId": "string",
      "notes": "string"
    }
  ],
  "sourceIncidentIds": [
    "string"
  ],
  "customFields": {
    "key": "string"
  }
}

Generated from the schema

A maintenance repair ticket: what broke and what is quoted to the customer for fixing it. unitPrice is a sale price, not a cost, because the cost of the repair is not published. It needs the incidence add-on. Repair tickets are bounded to the subscription that owns the key. The detail read, GET /api/v1/repair-tickets/{ticketId}, adds the lines, the project, the source incidents and the custom fields.

Attributes

idstring

Unique ticket identifier.

numberstring

Ticket number, for example "RT-2026-0001".

datestring<date-time>

Issue date in ISO 8601 UTC.

statusstring

Status of the ticket in its lifecycle.

Available options: draft, sent, partially_converted, fully_invoiced, closed

orderIdstring | null

Identifier of the order it comes from; null if it was created standalone.

orderNumberstring | null

Number of the order it comes from; null if it was created standalone.

contactIdstring | null

Identifier of the responsible client; null if none has been assigned.

contactNamestring | null

Name of the responsible client; null if not resolved.

subTotalstring

Sum of the lines before taxes, as a decimal string "1234.50".

Limits: pattern ^-?\d+\.\d{2}$

taxTotalstring

Tax total, as a decimal string "1234.50".

Limits: pattern ^-?\d+\.\d{2}$

totalstring

Total including taxes, as a decimal string "1234.50".

Limits: pattern ^-?\d+\.\d{2}$

totalLinesinteger

Number of lines in the ticket.

notesstring | null

General remarks; null if it has none.

createdAtstring<date-time>

Creation date in ISO 8601 UTC.

updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

projectIdstring | nullonly in the detail

Identifier of the associated project; null if it has none.

linesobject[]only in the detail

Ticket lines.

Show child attributes

lines.idstring

Unique line identifier.

lines.entityTypestring | null

Type of element being repaired: item, serializedItem (a specific unit), space or kit; null for a free line (a service, a charge).

Available options: item, serializedItem, space, kit

lines.entityIdstring | null

Identifier of the element being repaired; null if it is a free line.

lines.entityNamestring | null

Name of the element being repaired; null if not resolved.

lines.descriptionstring

What needs to be repaired.

lines.diagnosisstring | null

Technical diagnosis; null if none has been recorded.

lines.quantitynumber | null

Affected units; null if not applicable.

lines.unitPricestring | null

NET unit price quoted to the client, as a decimal string "1234.50". It is not the repair cost: that one is not published. null if the line has no price.

Limits: pattern ^-?\d+\.\d{2}$

lines.incidentIdstring | null

Identifier of the incident that originated this line; null if it does not come from one.

lines.notesstring | null

Line notes; null if it has none.

sourceIncidentIdsstring[]only in the detail

Identifiers of the incidents that originated the ticket.

customFieldsobject<string, any>only in the detail

Custom field values by custom field identifier; the definitions are in /api/v1/custom-fields.

Values

status: draft, sent, partially_converted, fully_invoiced, closed

Returned by

GET /api/v1/repair-tickets — List repair tickets
GET /api/v1/repair-tickets/{ticketId} — Get a repair ticket

Modified by

POST /api/v1/repair-tickets — Create a repair ticket
PATCH /api/v1/repair-tickets/{ticketId} — Update a repair ticket

Was this page helpful?