Repair tickets
Get a repair ticket
Returns the detail of a repair ticket with its lines: which element is repaired, its diagnosis and its price for the customer.
repair-tickets:readrepair-tickets:read- 120/min
- May need an add-on
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
Arguments
Repair ticket identifier.
Limits: min length 1
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Unique ticket identifier.
Ticket number, for example "RT-2026-0001".
Issue date in ISO 8601 UTC.
Status of the ticket in its lifecycle.
Available options: draft, sent, partially_converted, fully_invoiced, closed
Identifier of the order it comes from; null if it was created standalone.
Number of the order it comes from; null if it was created standalone.
Identifier of the responsible client; null if none has been assigned.
Name of the responsible client; null if not resolved.
Sum of the lines before taxes, as a decimal string "1234.50".
Limits: pattern ^-?\d+\.\d{2}$
Tax total, as a decimal string "1234.50".
Limits: pattern ^-?\d+\.\d{2}$
Total including taxes, as a decimal string "1234.50".
Limits: pattern ^-?\d+\.\d{2}$
Number of lines in the ticket.
General remarks; null if it has none.
Creation date in ISO 8601 UTC.
Last modification date in ISO 8601 UTC.
Identifier of the associated project; null if it has none.
Ticket lines.
Show child attributesHide child attributes
Unique line identifier.
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
Identifier of the element being repaired; null if it is a free line.
Name of the element being repaired; null if not resolved.
What needs to be repaired.
Technical diagnosis; null if none has been recorded.
Affected units; null if not applicable.
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}$
Identifier of the incident that originated this line; null if it does not come from one.
Line notes; null if it has none.
Identifiers of the incidents that originated the ticket.
Custom field values by custom field identifier; the definitions are in /api.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
The same operation by REST
This tool runs GET /api/v1/repair-tickets/{ticketId}.
Related pages
Link to this section: Related pagesRepair tickets
Get a repair ticket
Returns the detail of a repair ticket with its lines: which element is repaired, its diagnosis and its price for the customer.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?