With the Service module, a company tracks service calls (קריאות שירות): a customer reports a fault on a machine, a technician is assigned, the work and the parts are recorded, and the call is closed. Through API v2 your system can open calls, follow them and record the work, and hear about every change by webhook.
module_inactive. Scopes service:read and
service:write.
| Record | Is | Routes |
|---|---|---|
| service call | the call: customer, machine, status, type, technician, the fault and the work done | /service-calls |
| instrument | a machine the call covers, by line | /service-calls/{id}/instruments |
| line | a part or a charge, in a document line's names (unit_price, line_total_with_vat…) | /service-calls/{id}/lines |
| time | time logged, in its time type's unit | /service-calls/{id}/time |
| machine | a customer's equipment, with its counter readings | /machines, /machines/{id}/counters |
| lists | statuses (and each one's SMS template), types, time types, counters, conditions | /service-calls/statuses…, read-only |
POST /service-calls with at least the customer, the type and the status:
{
"customer_id": 376, "type_id": 1, "status_id": 1,
"machine_id": 55, "description": "Printer jams on every page",
"start_time": "2026-11-02T09:30:00"
}
Two fields work only here, as on the screen: fast_item adds a machine as the
first instrument, and auto_items adds that many new machines for the customer,
numbered from the company's serial prefix.
PATCH /service-calls/{id}; only the fields sent change.item_id brings the item's name,
unit, price and currency), instruments and time. Lines and instruments are changed and removed by
their line number; time is added, not changed.documents gives the ids of the ones it got.A closed call is read_only. Writing it, or its lines, instruments or time, answers
409, unless the company turns on API: allow changing a closed service call in
its service settings. There is no DELETE: a call is closed, not deleted.
Gold and above, as every webhook (Receiving webhook notifications):
| Event | When |
|---|---|
| service_call.created | a call is opened |
| service_call.updated | a call changes, or any of its instruments, lines or time. The payload is the whole call with them, as GET /service-calls/{id} answers it; one event per save, however many lines it touched |
| machine.created / machine.updated | a machine is added or changed |
They are offered only to a company with the Service module.
Every route, field and answer: API v2 › Service calls, Machines.