Repair tickets
Create a repair ticket
Opens a repair ticket with its lines.
repair-tickets:writerepair-tickets:write- 120/min
- May need an add-on
Result
generated from the schema
unitPrice is what is quoted to the CUSTOMER; the repair cost for the company neither goes in nor comes out through this API. incidentIds converts existing incidents and the server ties each line to its own. Behind the incidence add-on: without it, 402. Returns the full repair ticket, the same projection as its GET.
Arguments
Repair ticket date, in ISO 8601 with offset. Defaults to today.
Order from which the broken material returns.
Client invoiced for the repair.
Repair ticket lines. At least one.
Limits: min 1 items
Show child attributesHide child attributes
Existing line being modified. Omit it for a new line.
What needs to be repaired.
Limits: min length 1, max length 500
Technical diagnosis.
Limits: max length 5000
Type of element being repaired: item, space or kit. null or omitted for a free line.
Available options: item, space, kit
Element being repaired.
Specific physical unit, when a serialized item is repaired.
Incident that originates this line.
Affected units. Defaults to 1.
Limits: min 0
Net unit price quoted to the client, as a decimal string.
Limits: pattern ^\d{1,13}(\.\d{1,2})?$
Line notes.
Limits: max length 2000
Repair ticket notes.
Limits: max length 5000
Incidents this repair ticket converts. The server ties each line to its incident.
Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.
Limits: min length 1, max length 255
Optimistic locking: the meta.etag you got from the detail read of this resource (or "*"). If the resource changed since, the call fails with 412 precondition_failed before writing anything; read it again and retry. Omit it to write unconditionally.
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 POST /api/v1/repair-tickets.
Related pages
Link to this section: Related pagesRepair tickets
Create a repair ticket
Opens a repair ticket with its lines.
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?