Service requests

Base URL: $BUSINESS_API

The object

idstring · required
tenant_idstring · required
phonestring · required
full_namestring · optional
addressstring · required
plus_codestring · optional
localitystring · optional
landmarkstring · optional
service_typestring · required

one of new_connection

categorystring · required

one of residential, commercial, industrial, institutional, government

statusstring · required

one of submitted, accepted, visit_scheduled, quoted, payment_pending, scheduled, completed, declined, withdrawn

pricedboolean · required
estimate_min_centsinteger (int64) · optional
estimate_max_centsinteger (int64) · optional
currencystring · optional
decline_reasonstring · optional

Code from the tenant's configured decline reasons

decline_reason_labelstring · optional

The tenant's wording of the reason when it was chosen

decline_notestring · optional
account_idstring · optional

Account the connection was installed on; the requester is linked to it

account_numberstring · optional

Number of the referenced account, e.g. CTA-000044. Omitted when unknown.

account_holder_namestring · optional

Display name of the customer who holds the referenced account. Omitted when unknown.

customer_idstring · optional
customer_namestring · optional

Display name of the referenced customer. Omitted when unknown.

property_idstring · optional
property_addressstring · optional

Address line of the referenced property. Omitted when unknown.

property_holder_namestring · optional

Display name of the customer who holds the referenced property. Omitted when unknown.

connection_idstring · optional
connection_holder_namestring · optional

Display name of the customer who holds the referenced connection. Omitted when unknown.

connection_statusstring · optional
quote_idstring · optional

The current quote

site_visit_idstring · optional

The current site visit

invoice_idstring · optional

Invoice the accepted quote is paid through

payment_idstring · optional
receipt_numberstring · optional
work_order_idstring · optional

Installation work order booked once paid

installation_datestring (date) · optional
quoteobject · optional
Show child attributes
idstring · required
tenant_idstring · required
request_idstring · required
versioninteger · required
statusstring · required

one of issued, accepted, declined, superseded, expired, paid, cancelled

automaticboolean · required

Priced at once from the tariff without staff

site_visit_idstring · optional
tariff_version_idstring · optional
linesarray of ServiceQuoteLine · required
Show child attributes
idstring · required
positioninteger · required
kindstring · required

one of connection_fee, material, labour, other

charge_codestring · optional
descriptionstring · required
quantitynumber · required
list_price_centsinteger (int64) · optional

The tariff's unit price when the line came from it

unit_price_centsinteger (int64) · required
taxableboolean · required
total_centsinteger (int64) · required

Quantity times unit price

tax_centsinteger (int64) · required
adjustment_reasonstring · optional
subtotal_centsinteger (int64) · required
tax_centsinteger (int64) · required
total_centsinteger (int64) · required
currencystring · required
valid_untilstring (date-time) · required

Last day the quote can be accepted

notesstring · optional
issued_bystring · optional
issued_atstring (date-time) · required
accepted_atstring (date-time) · optional
declined_atstring (date-time) · optional
decline_notestring · optional
invoice_idstring · optional
invoice_numberstring · optional
payment_idstring · optional
receipt_numberstring · optional
paid_atstring (date-time) · optional
created_atstring (date-time) · optional
updated_atstring (date-time) · optional
site_visitobject · optional
Show child attributes
idstring · required
tenant_idstring · required
request_idstring · required
statusstring · required

one of scheduled, completed, cancelled

visit_datestring (date) · required
booked_bystring · required

one of consumer, staff

notesstring · optional
outcomestring · optional
quote_idstring · optional
completed_atstring (date-time) · optional
cancelled_atstring (date-time) · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required
can_book_visitboolean · optional

The requester may book a site visit from the offered days

decided_bystring · optional
decided_atstring (date-time) · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required
The object
{
  "id": "ser_2DBQqPj0WzZs0v5cORdA4r1imPJ",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "phone": "+258841234567",
  "full_name": "Ana Matsinhe",
  "address": "Av. Julius Nyerere 1420, Maputo",
  "plus_code": "PLU-2026-000142",
  "locality": "locality",
  "landmark": "landmark",
  "service_type": "new_connection",
  "category": "residential",
  "status": "submitted",
  "priced": true,
  "estimate_min_cents": 1,
  "estimate_max_cents": 1,
  "currency": "MZN",
  "decline_reason": "decline reason",
  "decline_reason_label": "decline reason label",
  "decline_note": "decline note",
  "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
  "account_number": "ACC-2026-000142",
  "account_holder_name": "Ana Matsinhe",
  "customer_id": "cus_2UuXtOGTHWKlvkoF5so5Joi3Hck",
  "customer_name": "Ana Matsinhe",
  "property_id": "prp_2ZbuIh1k2RvWMVPQCJD2yPrsOJ3",
  "property_address": "Av. Julius Nyerere 1420, Maputo",
  "property_holder_name": "Ana Matsinhe",
  "connection_id": "con_2wuJTWy9FOCTPGA3noGbHegbLaU",
  "connection_holder_name": "Ana Matsinhe",
  "connection_status": "connection status",
  "quote_id": "quo_26mh1wUlhIGz1c4BTWQl9M2dDyI",
  "site_visit_id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
  "invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
  "payment_id": "pay_2eUBfC8BJA6JLIoHrQwtN0GL1mW",
  "receipt_number": "REC-2026-000142",
  "work_order_id": "wko_2ecrvKOzr4kPhwgtrQAD7gM53yk",
  "installation_date": "2026-11-19",
  "quote": {
    "id": "ser_2cAPViWrBMoJHYSb9GajpwyHJEy",
    "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
    "request_id": "req_2JrY4JziCp1C0bFCSLb4M37qGNH",
    "version": 1,
    "status": "issued",
    "automatic": true,
    "site_visit_id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
    "tariff_version_id": "tar_2TzCwDDsMdpa2HfkINTSsLvKunb",
    "lines": [
      {
        "id": "ser_2bBeKTRWGj1a0TJoARlcel7MIL7",
        "position": 1,
        "kind": "connection_fee",
        "charge_code": "CHA-2026-000142",
        "description": "Leitura confirmada no local.",
        "quantity": 1,
        "list_price_cents": 125000,
        "unit_price_cents": 125000,
        "taxable": true,
        "total_cents": 125000,
        "tax_cents": 1,
        "adjustment_reason": "adjustment reason"
      }
    ],
    "subtotal_cents": 125000,
    "tax_cents": 1,
    "total_cents": 125000,
    "currency": "MZN",
    "valid_until": "2026-11-19T09:30:00Z",
    "notes": "Leitura confirmada no local.",
    "issued_by": "issued by",
    "issued_at": "2026-11-19T09:30:00Z",
    "accepted_at": "2026-11-19T09:30:00Z",
    "declined_at": "2026-11-19T09:30:00Z",
    "decline_note": "decline note",
    "invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
    "invoice_number": "INV-2026-000142",
    "payment_id": "pay_2eUBfC8BJA6JLIoHrQwtN0GL1mW",
    "receipt_number": "REC-2026-000142",
    "paid_at": "2026-11-19T09:30:00Z",
    "created_at": "2026-11-19T09:30:00Z",
    "updated_at": "2026-11-19T09:30:00Z"
  },
  "site_visit": {
    "id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
    "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
    "request_id": "req_2JrY4JziCp1C0bFCSLb4M37qGNH",
    "status": "scheduled",
    "visit_date": "2026-11-19",
    "booked_by": "consumer",
    "notes": "Leitura confirmada no local.",
    "outcome": "outcome",
    "quote_id": "quo_26mh1wUlhIGz1c4BTWQl9M2dDyI",
    "completed_at": "2026-11-19T09:30:00Z",
    "cancelled_at": "2026-11-19T09:30:00Z",
    "created_at": "2026-11-19T09:30:00Z",
    "updated_at": "2026-11-19T09:30:00Z"
  },
  "can_book_visit": true,
  "decided_by": "decided by",
  "decided_at": "2026-11-19T09:30:00Z",
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z"
}

List the utility's service request queue

Logs

GET /service-requests

Returns the service requests submitted to the caller's tenant, newest-first pages of at most 100 items (20 by default) driven by limit and the after cursor. Before each item is returned its quote state is brought up to date, so a quote whose validity has passed shows as expired and a paid quote moves the request forward. Requires the connections:read permission.

Parameters

statusstring · query · optional

Returns only requests in this exact status (submitted, accepted, declined, withdrawn, visit_scheduled, quoted, payment_pending, scheduled or completed); omit it to list requests in every status.

one of submitted, accepted, declined, withdrawn

limitinteger · query · optional

Maximum resources to return (default 20, maximum 100).

afterstring · query · optional

Opaque cursor returned by the previous page.

Returns

200 Service requests of the authenticated utility tenant

Show attributes
dataarray of ServiceRequest · required
Show child attributes
idstring · required
tenant_idstring · required
phonestring · required
full_namestring · optional
addressstring · required
plus_codestring · optional
localitystring · optional
landmarkstring · optional
service_typestring · required

one of new_connection

categorystring · required

one of residential, commercial, industrial, institutional, government

statusstring · required

one of submitted, accepted, visit_scheduled, quoted, payment_pending, scheduled, completed, declined, withdrawn

pricedboolean · required
estimate_min_centsinteger (int64) · optional
estimate_max_centsinteger (int64) · optional
currencystring · optional
decline_reasonstring · optional

Code from the tenant's configured decline reasons

decline_reason_labelstring · optional

The tenant's wording of the reason when it was chosen

decline_notestring · optional
account_idstring · optional

Account the connection was installed on; the requester is linked to it

account_numberstring · optional

Number of the referenced account, e.g. CTA-000044. Omitted when unknown.

account_holder_namestring · optional

Display name of the customer who holds the referenced account. Omitted when unknown.

customer_idstring · optional
customer_namestring · optional

Display name of the referenced customer. Omitted when unknown.

property_idstring · optional
property_addressstring · optional

Address line of the referenced property. Omitted when unknown.

property_holder_namestring · optional

Display name of the customer who holds the referenced property. Omitted when unknown.

connection_idstring · optional
connection_holder_namestring · optional

Display name of the customer who holds the referenced connection. Omitted when unknown.

connection_statusstring · optional
quote_idstring · optional

The current quote

site_visit_idstring · optional

The current site visit

invoice_idstring · optional

Invoice the accepted quote is paid through

payment_idstring · optional
receipt_numberstring · optional
work_order_idstring · optional

Installation work order booked once paid

installation_datestring (date) · optional
quoteobject · optional
Show child attributes
idstring · required
tenant_idstring · required
request_idstring · required
versioninteger · required
statusstring · required

one of issued, accepted, declined, superseded, expired, paid, cancelled

automaticboolean · required

Priced at once from the tariff without staff

site_visit_idstring · optional
tariff_version_idstring · optional
linesarray of ServiceQuoteLine · required
Show child attributes
idstring · required
positioninteger · required
kindstring · required

one of connection_fee, material, labour, other

charge_codestring · optional
descriptionstring · required
quantitynumber · required
list_price_centsinteger (int64) · optional

The tariff's unit price when the line came from it

unit_price_centsinteger (int64) · required
taxableboolean · required
total_centsinteger (int64) · required

Quantity times unit price

tax_centsinteger (int64) · required
adjustment_reasonstring · optional
subtotal_centsinteger (int64) · required
tax_centsinteger (int64) · required
total_centsinteger (int64) · required
currencystring · required
valid_untilstring (date-time) · required

Last day the quote can be accepted

notesstring · optional
issued_bystring · optional
issued_atstring (date-time) · required
accepted_atstring (date-time) · optional
declined_atstring (date-time) · optional
decline_notestring · optional
invoice_idstring · optional
invoice_numberstring · optional
payment_idstring · optional
receipt_numberstring · optional
paid_atstring (date-time) · optional
created_atstring (date-time) · optional
updated_atstring (date-time) · optional
site_visitobject · optional
Show child attributes
idstring · required
tenant_idstring · required
request_idstring · required
statusstring · required

one of scheduled, completed, cancelled

visit_datestring (date) · required
booked_bystring · required

one of consumer, staff

notesstring · optional
outcomestring · optional
quote_idstring · optional
completed_atstring (date-time) · optional
cancelled_atstring (date-time) · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required
can_book_visitboolean · optional

The requester may book a site visit from the offered days

decided_bystring · optional
decided_atstring (date-time) · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required
has_moreboolean · required
next_cursorstring · optional

Errors 403

Permissions connections:read · Roles: admin, analyst, customer_service, operations, owner, viewer

curl -X GET "$BUSINESS_API/service-requests" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "data": [
    {
      "id": "ser_2DBQqPj0WzZs0v5cORdA4r1imPJ",
      "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
      "phone": "+258841234567",
      "full_name": "Ana Matsinhe",
      "address": "Av. Julius Nyerere 1420, Maputo",
      "plus_code": "PLU-2026-000142",
      "locality": "locality",
      "landmark": "landmark",
      "service_type": "new_connection",
      "category": "residential",
      "status": "submitted",
      "priced": true,
      "estimate_min_cents": 1,
      "estimate_max_cents": 1,
      "currency": "MZN",
      "decline_reason": "decline reason",
      "decline_reason_label": "decline reason label",
      "decline_note": "decline note",
      "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
      "account_number": "ACC-2026-000142",
      "account_holder_name": "Ana Matsinhe",
      "customer_id": "cus_2UuXtOGTHWKlvkoF5so5Joi3Hck",
      "customer_name": "Ana Matsinhe",
      "property_id": "prp_2ZbuIh1k2RvWMVPQCJD2yPrsOJ3",
      "property_address": "Av. Julius Nyerere 1420, Maputo",
      "property_holder_name": "Ana Matsinhe",
      "connection_id": "con_2wuJTWy9FOCTPGA3noGbHegbLaU",
      "connection_holder_name": "Ana Matsinhe",
      "connection_status": "connection status",
      "quote_id": "quo_26mh1wUlhIGz1c4BTWQl9M2dDyI",
      "site_visit_id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
      "invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
      "payment_id": "pay_2eUBfC8BJA6JLIoHrQwtN0GL1mW",
      "receipt_number": "REC-2026-000142",
      "work_order_id": "wko_2ecrvKOzr4kPhwgtrQAD7gM53yk",
      "installation_date": "2026-11-19",
      "quote": {
        "id": "ser_2cAPViWrBMoJHYSb9GajpwyHJEy",
        "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
        "request_id": "req_2JrY4JziCp1C0bFCSLb4M37qGNH",
        "version": 1,
        "status": "issued",
        "automatic": true,
        "site_visit_id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
        "tariff_version_id": "tar_2TzCwDDsMdpa2HfkINTSsLvKunb",
        "lines": [
          {
            "id": "ser_2bBeKTRWGj1a0TJoARlcel7MIL7",
            "position": 1,
            "kind": "connection_fee",
            "charge_code": "CHA-2026-000142",
            "description": "Leitura confirmada no local.",
            "quantity": 1,
            "list_price_cents": 125000,
            "unit_price_cents": 125000,
            "taxable": true,
            "total_cents": 125000,
            "tax_cents": 1,
            "adjustment_reason": "adjustment reason"
          }
        ],
        "subtotal_cents": 125000,
        "tax_cents": 1,
        "total_cents": 125000,
        "currency": "MZN",
        "valid_until": "2026-11-19T09:30:00Z",
        "notes": "Leitura confirmada no local.",
        "issued_by": "issued by",
        "issued_at": "2026-11-19T09:30:00Z",
        "accepted_at": "2026-11-19T09:30:00Z",
        "declined_at": "2026-11-19T09:30:00Z",
        "decline_note": "decline note",
        "invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
        "invoice_number": "INV-2026-000142",
        "payment_id": "pay_2eUBfC8BJA6JLIoHrQwtN0GL1mW",
        "receipt_number": "REC-2026-000142",
        "paid_at": "2026-11-19T09:30:00Z",
        "created_at": "2026-11-19T09:30:00Z",
        "updated_at": "2026-11-19T09:30:00Z"
      },
      "site_visit": {
        "id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
        "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
        "request_id": "req_2JrY4JziCp1C0bFCSLb4M37qGNH",
        "status": "scheduled",
        "visit_date": "2026-11-19",
        "booked_by": "consumer",
        "notes": "Leitura confirmada no local.",
        "outcome": "outcome",
        "quote_id": "quo_26mh1wUlhIGz1c4BTWQl9M2dDyI",
        "completed_at": "2026-11-19T09:30:00Z",
        "cancelled_at": "2026-11-19T09:30:00Z",
        "created_at": "2026-11-19T09:30:00Z",
        "updated_at": "2026-11-19T09:30:00Z"
      },
      "can_book_visit": true,
      "decided_by": "decided by",
      "decided_at": "2026-11-19T09:30:00Z",
      "created_at": "2026-11-19T09:30:00Z",
      "updated_at": "2026-11-19T09:30:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "next cursor"
}

Get a service request of the utility's queue

Logs

GET /service-requests/{id}

Returns one request from the tenant's queue together with its current quote, its site visit and, once accepted, the connection created for it. The quote state is refreshed on read, so an overdue quote is marked expired and a settled one advances the request. Returns 404 when the ID does not belong to the caller's tenant; requires connections:read.

Parameters

idstring · path · required

ID of the service request in the caller's tenant.

Returns

200 Service request

Show attributes
idstring · required
tenant_idstring · required
phonestring · required
full_namestring · optional
addressstring · required
plus_codestring · optional
localitystring · optional
landmarkstring · optional
service_typestring · required

one of new_connection

categorystring · required

one of residential, commercial, industrial, institutional, government

statusstring · required

one of submitted, accepted, visit_scheduled, quoted, payment_pending, scheduled, completed, declined, withdrawn

pricedboolean · required
estimate_min_centsinteger (int64) · optional
estimate_max_centsinteger (int64) · optional
currencystring · optional
decline_reasonstring · optional

Code from the tenant's configured decline reasons

decline_reason_labelstring · optional

The tenant's wording of the reason when it was chosen

decline_notestring · optional
account_idstring · optional

Account the connection was installed on; the requester is linked to it

account_numberstring · optional

Number of the referenced account, e.g. CTA-000044. Omitted when unknown.

account_holder_namestring · optional

Display name of the customer who holds the referenced account. Omitted when unknown.

customer_idstring · optional
customer_namestring · optional

Display name of the referenced customer. Omitted when unknown.

property_idstring · optional
property_addressstring · optional

Address line of the referenced property. Omitted when unknown.

property_holder_namestring · optional

Display name of the customer who holds the referenced property. Omitted when unknown.

connection_idstring · optional
connection_holder_namestring · optional

Display name of the customer who holds the referenced connection. Omitted when unknown.

connection_statusstring · optional
quote_idstring · optional

The current quote

site_visit_idstring · optional

The current site visit

invoice_idstring · optional

Invoice the accepted quote is paid through

payment_idstring · optional
receipt_numberstring · optional
work_order_idstring · optional

Installation work order booked once paid

installation_datestring (date) · optional
quoteobject · optional
Show child attributes
idstring · required
tenant_idstring · required
request_idstring · required
versioninteger · required
statusstring · required

one of issued, accepted, declined, superseded, expired, paid, cancelled

automaticboolean · required

Priced at once from the tariff without staff

site_visit_idstring · optional
tariff_version_idstring · optional
linesarray of ServiceQuoteLine · required
Show child attributes
idstring · required
positioninteger · required
kindstring · required

one of connection_fee, material, labour, other

charge_codestring · optional
descriptionstring · required
quantitynumber · required
list_price_centsinteger (int64) · optional

The tariff's unit price when the line came from it

unit_price_centsinteger (int64) · required
taxableboolean · required
total_centsinteger (int64) · required

Quantity times unit price

tax_centsinteger (int64) · required
adjustment_reasonstring · optional
subtotal_centsinteger (int64) · required
tax_centsinteger (int64) · required
total_centsinteger (int64) · required
currencystring · required
valid_untilstring (date-time) · required

Last day the quote can be accepted

notesstring · optional
issued_bystring · optional
issued_atstring (date-time) · required
accepted_atstring (date-time) · optional
declined_atstring (date-time) · optional
decline_notestring · optional
invoice_idstring · optional
invoice_numberstring · optional
payment_idstring · optional
receipt_numberstring · optional
paid_atstring (date-time) · optional
created_atstring (date-time) · optional
updated_atstring (date-time) · optional
site_visitobject · optional
Show child attributes
idstring · required
tenant_idstring · required
request_idstring · required
statusstring · required

one of scheduled, completed, cancelled

visit_datestring (date) · required
booked_bystring · required

one of consumer, staff

notesstring · optional
outcomestring · optional
quote_idstring · optional
completed_atstring (date-time) · optional
cancelled_atstring (date-time) · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required
can_book_visitboolean · optional

The requester may book a site visit from the offered days

decided_bystring · optional
decided_atstring (date-time) · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required

Errors 403 · 404

Permissions connections:read · Roles: admin, analyst, customer_service, operations, owner, viewer

curl -X GET "$BUSINESS_API/service-requests/{id}" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "id": "ser_2DBQqPj0WzZs0v5cORdA4r1imPJ",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "phone": "+258841234567",
  "full_name": "Ana Matsinhe",
  "address": "Av. Julius Nyerere 1420, Maputo",
  "plus_code": "PLU-2026-000142",
  "locality": "locality",
  "landmark": "landmark",
  "service_type": "new_connection",
  "category": "residential",
  "status": "submitted",
  "priced": true,
  "estimate_min_cents": 1,
  "estimate_max_cents": 1,
  "currency": "MZN",
  "decline_reason": "decline reason",
  "decline_reason_label": "decline reason label",
  "decline_note": "decline note",
  "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
  "account_number": "ACC-2026-000142",
  "account_holder_name": "Ana Matsinhe",
  "customer_id": "cus_2UuXtOGTHWKlvkoF5so5Joi3Hck",
  "customer_name": "Ana Matsinhe",
  "property_id": "prp_2ZbuIh1k2RvWMVPQCJD2yPrsOJ3",
  "property_address": "Av. Julius Nyerere 1420, Maputo",
  "property_holder_name": "Ana Matsinhe",
  "connection_id": "con_2wuJTWy9FOCTPGA3noGbHegbLaU",
  "connection_holder_name": "Ana Matsinhe",
  "connection_status": "connection status",
  "quote_id": "quo_26mh1wUlhIGz1c4BTWQl9M2dDyI",
  "site_visit_id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
  "invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
  "payment_id": "pay_2eUBfC8BJA6JLIoHrQwtN0GL1mW",
  "receipt_number": "REC-2026-000142",
  "work_order_id": "wko_2ecrvKOzr4kPhwgtrQAD7gM53yk",
  "installation_date": "2026-11-19",
  "quote": {
    "id": "ser_2cAPViWrBMoJHYSb9GajpwyHJEy",
    "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
    "request_id": "req_2JrY4JziCp1C0bFCSLb4M37qGNH",
    "version": 1,
    "status": "issued",
    "automatic": true,
    "site_visit_id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
    "tariff_version_id": "tar_2TzCwDDsMdpa2HfkINTSsLvKunb",
    "lines": [
      {
        "id": "ser_2bBeKTRWGj1a0TJoARlcel7MIL7",
        "position": 1,
        "kind": "connection_fee",
        "charge_code": "CHA-2026-000142",
        "description": "Leitura confirmada no local.",
        "quantity": 1,
        "list_price_cents": 125000,
        "unit_price_cents": 125000,
        "taxable": true,
        "total_cents": 125000,
        "tax_cents": 1,
        "adjustment_reason": "adjustment reason"
      }
    ],
    "subtotal_cents": 125000,
    "tax_cents": 1,
    "total_cents": 125000,
    "currency": "MZN",
    "valid_until": "2026-11-19T09:30:00Z",
    "notes": "Leitura confirmada no local.",
    "issued_by": "issued by",
    "issued_at": "2026-11-19T09:30:00Z",
    "accepted_at": "2026-11-19T09:30:00Z",
    "declined_at": "2026-11-19T09:30:00Z",
    "decline_note": "decline note",
    "invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
    "invoice_number": "INV-2026-000142",
    "payment_id": "pay_2eUBfC8BJA6JLIoHrQwtN0GL1mW",
    "receipt_number": "REC-2026-000142",
    "paid_at": "2026-11-19T09:30:00Z",
    "created_at": "2026-11-19T09:30:00Z",
    "updated_at": "2026-11-19T09:30:00Z"
  },
  "site_visit": {
    "id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
    "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
    "request_id": "req_2JrY4JziCp1C0bFCSLb4M37qGNH",
    "status": "scheduled",
    "visit_date": "2026-11-19",
    "booked_by": "consumer",
    "notes": "Leitura confirmada no local.",
    "outcome": "outcome",
    "quote_id": "quo_26mh1wUlhIGz1c4BTWQl9M2dDyI",
    "completed_at": "2026-11-19T09:30:00Z",
    "cancelled_at": "2026-11-19T09:30:00Z",
    "created_at": "2026-11-19T09:30:00Z",
    "updated_at": "2026-11-19T09:30:00Z"
  },
  "can_book_visit": true,
  "decided_by": "decided by",
  "decided_at": "2026-11-19T09:30:00Z",
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z"
}

Accept a service request

Logs

POST /service-requests/{id}/accept

Creates the customer and premise from the request under the caller's own permissions (business:customers:create, business:properties:create) and files a connection application (connections:write). A retry reuses a customer already created.

Parameters

idstring · path · required

ID of the open service request in the caller's tenant to accept.

Body application/json

categorystring · optional

one of residential, commercial, industrial, institutional, government

diameter_mminteger · optional
notesstring · optional

Returns

200 Accepted request with customer_id, property_id and connection_id

Show attributes
idstring · required
tenant_idstring · required
phonestring · required
full_namestring · optional
addressstring · required
plus_codestring · optional
localitystring · optional
landmarkstring · optional
service_typestring · required

one of new_connection

categorystring · required

one of residential, commercial, industrial, institutional, government

statusstring · required

one of submitted, accepted, visit_scheduled, quoted, payment_pending, scheduled, completed, declined, withdrawn

pricedboolean · required
estimate_min_centsinteger (int64) · optional
estimate_max_centsinteger (int64) · optional
currencystring · optional
decline_reasonstring · optional

Code from the tenant's configured decline reasons

decline_reason_labelstring · optional

The tenant's wording of the reason when it was chosen

decline_notestring · optional
account_idstring · optional

Account the connection was installed on; the requester is linked to it

account_numberstring · optional

Number of the referenced account, e.g. CTA-000044. Omitted when unknown.

account_holder_namestring · optional

Display name of the customer who holds the referenced account. Omitted when unknown.

customer_idstring · optional
customer_namestring · optional

Display name of the referenced customer. Omitted when unknown.

property_idstring · optional
property_addressstring · optional

Address line of the referenced property. Omitted when unknown.

property_holder_namestring · optional

Display name of the customer who holds the referenced property. Omitted when unknown.

connection_idstring · optional
connection_holder_namestring · optional

Display name of the customer who holds the referenced connection. Omitted when unknown.

connection_statusstring · optional
quote_idstring · optional

The current quote

site_visit_idstring · optional

The current site visit

invoice_idstring · optional

Invoice the accepted quote is paid through

payment_idstring · optional
receipt_numberstring · optional
work_order_idstring · optional

Installation work order booked once paid

installation_datestring (date) · optional
quoteobject · optional
Show child attributes
idstring · required
tenant_idstring · required
request_idstring · required
versioninteger · required
statusstring · required

one of issued, accepted, declined, superseded, expired, paid, cancelled

automaticboolean · required

Priced at once from the tariff without staff

site_visit_idstring · optional
tariff_version_idstring · optional
linesarray of ServiceQuoteLine · required
Show child attributes
idstring · required
positioninteger · required
kindstring · required

one of connection_fee, material, labour, other

charge_codestring · optional
descriptionstring · required
quantitynumber · required
list_price_centsinteger (int64) · optional

The tariff's unit price when the line came from it

unit_price_centsinteger (int64) · required
taxableboolean · required
total_centsinteger (int64) · required

Quantity times unit price

tax_centsinteger (int64) · required
adjustment_reasonstring · optional
subtotal_centsinteger (int64) · required
tax_centsinteger (int64) · required
total_centsinteger (int64) · required
currencystring · required
valid_untilstring (date-time) · required

Last day the quote can be accepted

notesstring · optional
issued_bystring · optional
issued_atstring (date-time) · required
accepted_atstring (date-time) · optional
declined_atstring (date-time) · optional
decline_notestring · optional
invoice_idstring · optional
invoice_numberstring · optional
payment_idstring · optional
receipt_numberstring · optional
paid_atstring (date-time) · optional
created_atstring (date-time) · optional
updated_atstring (date-time) · optional
site_visitobject · optional
Show child attributes
idstring · required
tenant_idstring · required
request_idstring · required
statusstring · required

one of scheduled, completed, cancelled

visit_datestring (date) · required
booked_bystring · required

one of consumer, staff

notesstring · optional
outcomestring · optional
quote_idstring · optional
completed_atstring (date-time) · optional
cancelled_atstring (date-time) · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required
can_book_visitboolean · optional

The requester may book a site visit from the offered days

decided_bystring · optional
decided_atstring (date-time) · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required

Errors 400 · 403 · 404

Permissions connections:write · Roles: admin, operations, owner

curl -X POST "$BUSINESS_API/service-requests/{id}/accept" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "category": "residential",
  "diameter_mm": 1,
  "notes": "Leitura confirmada no local."
}'
Response 200
{
  "id": "ser_2DBQqPj0WzZs0v5cORdA4r1imPJ",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "phone": "+258841234567",
  "full_name": "Ana Matsinhe",
  "address": "Av. Julius Nyerere 1420, Maputo",
  "plus_code": "PLU-2026-000142",
  "locality": "locality",
  "landmark": "landmark",
  "service_type": "new_connection",
  "category": "residential",
  "status": "submitted",
  "priced": true,
  "estimate_min_cents": 1,
  "estimate_max_cents": 1,
  "currency": "MZN",
  "decline_reason": "decline reason",
  "decline_reason_label": "decline reason label",
  "decline_note": "decline note",
  "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
  "account_number": "ACC-2026-000142",
  "account_holder_name": "Ana Matsinhe",
  "customer_id": "cus_2UuXtOGTHWKlvkoF5so5Joi3Hck",
  "customer_name": "Ana Matsinhe",
  "property_id": "prp_2ZbuIh1k2RvWMVPQCJD2yPrsOJ3",
  "property_address": "Av. Julius Nyerere 1420, Maputo",
  "property_holder_name": "Ana Matsinhe",
  "connection_id": "con_2wuJTWy9FOCTPGA3noGbHegbLaU",
  "connection_holder_name": "Ana Matsinhe",
  "connection_status": "connection status",
  "quote_id": "quo_26mh1wUlhIGz1c4BTWQl9M2dDyI",
  "site_visit_id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
  "invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
  "payment_id": "pay_2eUBfC8BJA6JLIoHrQwtN0GL1mW",
  "receipt_number": "REC-2026-000142",
  "work_order_id": "wko_2ecrvKOzr4kPhwgtrQAD7gM53yk",
  "installation_date": "2026-11-19",
  "quote": {
    "id": "ser_2cAPViWrBMoJHYSb9GajpwyHJEy",
    "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
    "request_id": "req_2JrY4JziCp1C0bFCSLb4M37qGNH",
    "version": 1,
    "status": "issued",
    "automatic": true,
    "site_visit_id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
    "tariff_version_id": "tar_2TzCwDDsMdpa2HfkINTSsLvKunb",
    "lines": [
      {
        "id": "ser_2bBeKTRWGj1a0TJoARlcel7MIL7",
        "position": 1,
        "kind": "connection_fee",
        "charge_code": "CHA-2026-000142",
        "description": "Leitura confirmada no local.",
        "quantity": 1,
        "list_price_cents": 125000,
        "unit_price_cents": 125000,
        "taxable": true,
        "total_cents": 125000,
        "tax_cents": 1,
        "adjustment_reason": "adjustment reason"
      }
    ],
    "subtotal_cents": 125000,
    "tax_cents": 1,
    "total_cents": 125000,
    "currency": "MZN",
    "valid_until": "2026-11-19T09:30:00Z",
    "notes": "Leitura confirmada no local.",
    "issued_by": "issued by",
    "issued_at": "2026-11-19T09:30:00Z",
    "accepted_at": "2026-11-19T09:30:00Z",
    "declined_at": "2026-11-19T09:30:00Z",
    "decline_note": "decline note",
    "invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
    "invoice_number": "INV-2026-000142",
    "payment_id": "pay_2eUBfC8BJA6JLIoHrQwtN0GL1mW",
    "receipt_number": "REC-2026-000142",
    "paid_at": "2026-11-19T09:30:00Z",
    "created_at": "2026-11-19T09:30:00Z",
    "updated_at": "2026-11-19T09:30:00Z"
  },
  "site_visit": {
    "id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
    "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
    "request_id": "req_2JrY4JziCp1C0bFCSLb4M37qGNH",
    "status": "scheduled",
    "visit_date": "2026-11-19",
    "booked_by": "consumer",
    "notes": "Leitura confirmada no local.",
    "outcome": "outcome",
    "quote_id": "quo_26mh1wUlhIGz1c4BTWQl9M2dDyI",
    "completed_at": "2026-11-19T09:30:00Z",
    "cancelled_at": "2026-11-19T09:30:00Z",
    "created_at": "2026-11-19T09:30:00Z",
    "updated_at": "2026-11-19T09:30:00Z"
  },
  "can_book_visit": true,
  "decided_by": "decided by",
  "decided_at": "2026-11-19T09:30:00Z",
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z"
}

Decline a service request with a reason from the list

Logs

POST /service-requests/{id}/decline

The reason and note are shown to the requester only, never on the public status lookup.

Parameters

idstring · path · required

ID of the open service request in the caller's tenant to decline.

Body application/json

reasonstring · required

An active code from GET $BUSINESS_API/service-request-decline-reasons

notestring · optional

Returns

200 Declined request

Show attributes
idstring · required
tenant_idstring · required
phonestring · required
full_namestring · optional
addressstring · required
plus_codestring · optional
localitystring · optional
landmarkstring · optional
service_typestring · required

one of new_connection

categorystring · required

one of residential, commercial, industrial, institutional, government

statusstring · required

one of submitted, accepted, visit_scheduled, quoted, payment_pending, scheduled, completed, declined, withdrawn

pricedboolean · required
estimate_min_centsinteger (int64) · optional
estimate_max_centsinteger (int64) · optional
currencystring · optional
decline_reasonstring · optional

Code from the tenant's configured decline reasons

decline_reason_labelstring · optional

The tenant's wording of the reason when it was chosen

decline_notestring · optional
account_idstring · optional

Account the connection was installed on; the requester is linked to it

account_numberstring · optional

Number of the referenced account, e.g. CTA-000044. Omitted when unknown.

account_holder_namestring · optional

Display name of the customer who holds the referenced account. Omitted when unknown.

customer_idstring · optional
customer_namestring · optional

Display name of the referenced customer. Omitted when unknown.

property_idstring · optional
property_addressstring · optional

Address line of the referenced property. Omitted when unknown.

property_holder_namestring · optional

Display name of the customer who holds the referenced property. Omitted when unknown.

connection_idstring · optional
connection_holder_namestring · optional

Display name of the customer who holds the referenced connection. Omitted when unknown.

connection_statusstring · optional
quote_idstring · optional

The current quote

site_visit_idstring · optional

The current site visit

invoice_idstring · optional

Invoice the accepted quote is paid through

payment_idstring · optional
receipt_numberstring · optional
work_order_idstring · optional

Installation work order booked once paid

installation_datestring (date) · optional
quoteobject · optional
Show child attributes
idstring · required
tenant_idstring · required
request_idstring · required
versioninteger · required
statusstring · required

one of issued, accepted, declined, superseded, expired, paid, cancelled

automaticboolean · required

Priced at once from the tariff without staff

site_visit_idstring · optional
tariff_version_idstring · optional
linesarray of ServiceQuoteLine · required
Show child attributes
idstring · required
positioninteger · required
kindstring · required

one of connection_fee, material, labour, other

charge_codestring · optional
descriptionstring · required
quantitynumber · required
list_price_centsinteger (int64) · optional

The tariff's unit price when the line came from it

unit_price_centsinteger (int64) · required
taxableboolean · required
total_centsinteger (int64) · required

Quantity times unit price

tax_centsinteger (int64) · required
adjustment_reasonstring · optional
subtotal_centsinteger (int64) · required
tax_centsinteger (int64) · required
total_centsinteger (int64) · required
currencystring · required
valid_untilstring (date-time) · required

Last day the quote can be accepted

notesstring · optional
issued_bystring · optional
issued_atstring (date-time) · required
accepted_atstring (date-time) · optional
declined_atstring (date-time) · optional
decline_notestring · optional
invoice_idstring · optional
invoice_numberstring · optional
payment_idstring · optional
receipt_numberstring · optional
paid_atstring (date-time) · optional
created_atstring (date-time) · optional
updated_atstring (date-time) · optional
site_visitobject · optional
Show child attributes
idstring · required
tenant_idstring · required
request_idstring · required
statusstring · required

one of scheduled, completed, cancelled

visit_datestring (date) · required
booked_bystring · required

one of consumer, staff

notesstring · optional
outcomestring · optional
quote_idstring · optional
completed_atstring (date-time) · optional
cancelled_atstring (date-time) · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required
can_book_visitboolean · optional

The requester may book a site visit from the offered days

decided_bystring · optional
decided_atstring (date-time) · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required

Errors 400 · 403 · 404

Permissions connections:write · Roles: admin, operations, owner

curl -X POST "$BUSINESS_API/service-requests/{id}/decline" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "Leitura confirmada no local.",
  "note": "Leitura confirmada no local."
}'
Response 200
{
  "id": "ser_2DBQqPj0WzZs0v5cORdA4r1imPJ",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "phone": "+258841234567",
  "full_name": "Ana Matsinhe",
  "address": "Av. Julius Nyerere 1420, Maputo",
  "plus_code": "PLU-2026-000142",
  "locality": "locality",
  "landmark": "landmark",
  "service_type": "new_connection",
  "category": "residential",
  "status": "submitted",
  "priced": true,
  "estimate_min_cents": 1,
  "estimate_max_cents": 1,
  "currency": "MZN",
  "decline_reason": "decline reason",
  "decline_reason_label": "decline reason label",
  "decline_note": "decline note",
  "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
  "account_number": "ACC-2026-000142",
  "account_holder_name": "Ana Matsinhe",
  "customer_id": "cus_2UuXtOGTHWKlvkoF5so5Joi3Hck",
  "customer_name": "Ana Matsinhe",
  "property_id": "prp_2ZbuIh1k2RvWMVPQCJD2yPrsOJ3",
  "property_address": "Av. Julius Nyerere 1420, Maputo",
  "property_holder_name": "Ana Matsinhe",
  "connection_id": "con_2wuJTWy9FOCTPGA3noGbHegbLaU",
  "connection_holder_name": "Ana Matsinhe",
  "connection_status": "connection status",
  "quote_id": "quo_26mh1wUlhIGz1c4BTWQl9M2dDyI",
  "site_visit_id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
  "invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
  "payment_id": "pay_2eUBfC8BJA6JLIoHrQwtN0GL1mW",
  "receipt_number": "REC-2026-000142",
  "work_order_id": "wko_2ecrvKOzr4kPhwgtrQAD7gM53yk",
  "installation_date": "2026-11-19",
  "quote": {
    "id": "ser_2cAPViWrBMoJHYSb9GajpwyHJEy",
    "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
    "request_id": "req_2JrY4JziCp1C0bFCSLb4M37qGNH",
    "version": 1,
    "status": "issued",
    "automatic": true,
    "site_visit_id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
    "tariff_version_id": "tar_2TzCwDDsMdpa2HfkINTSsLvKunb",
    "lines": [
      {
        "id": "ser_2bBeKTRWGj1a0TJoARlcel7MIL7",
        "position": 1,
        "kind": "connection_fee",
        "charge_code": "CHA-2026-000142",
        "description": "Leitura confirmada no local.",
        "quantity": 1,
        "list_price_cents": 125000,
        "unit_price_cents": 125000,
        "taxable": true,
        "total_cents": 125000,
        "tax_cents": 1,
        "adjustment_reason": "adjustment reason"
      }
    ],
    "subtotal_cents": 125000,
    "tax_cents": 1,
    "total_cents": 125000,
    "currency": "MZN",
    "valid_until": "2026-11-19T09:30:00Z",
    "notes": "Leitura confirmada no local.",
    "issued_by": "issued by",
    "issued_at": "2026-11-19T09:30:00Z",
    "accepted_at": "2026-11-19T09:30:00Z",
    "declined_at": "2026-11-19T09:30:00Z",
    "decline_note": "decline note",
    "invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
    "invoice_number": "INV-2026-000142",
    "payment_id": "pay_2eUBfC8BJA6JLIoHrQwtN0GL1mW",
    "receipt_number": "REC-2026-000142",
    "paid_at": "2026-11-19T09:30:00Z",
    "created_at": "2026-11-19T09:30:00Z",
    "updated_at": "2026-11-19T09:30:00Z"
  },
  "site_visit": {
    "id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
    "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
    "request_id": "req_2JrY4JziCp1C0bFCSLb4M37qGNH",
    "status": "scheduled",
    "visit_date": "2026-11-19",
    "booked_by": "consumer",
    "notes": "Leitura confirmada no local.",
    "outcome": "outcome",
    "quote_id": "quo_26mh1wUlhIGz1c4BTWQl9M2dDyI",
    "completed_at": "2026-11-19T09:30:00Z",
    "cancelled_at": "2026-11-19T09:30:00Z",
    "created_at": "2026-11-19T09:30:00Z",
    "updated_at": "2026-11-19T09:30:00Z"
  },
  "can_book_visit": true,
  "decided_by": "decided by",
  "decided_at": "2026-11-19T09:30:00Z",
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z"
}

List the tariff prices a request's quote can use

Logs

GET /service-requests/{id}/quote-prices

Fixed components of the active tariff for the request's category whose accounting role is connection_fee, connection_material or connection_labour (RFC 0104 §7.1). Empty when the tenant has priced none; staff can still write free lines with a reason.

Parameters

idstring · path · required

ID of the service request whose category selects the tariff prices.

Returns

200 Price catalogue

Show attributes
tariff_version_idstring · optional
currencystring · optional
tax_percentnumber · required
pricesarray of object · required
Show child attributes
keystring · required

Names the price on a quote line; code

codestring · required
namestring · required
kindstring · required

one of connection_fee, material, labour

amount_centsinteger (int64) · required
taxableboolean · required
diameter_mminteger · optional
one_timeboolean · required

Errors 403 · 404

Permissions connections:read · Roles: admin, analyst, customer_service, operations, owner, viewer

curl -X GET "$BUSINESS_API/service-requests/{id}/quote-prices" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "tariff_version_id": "tar_2TzCwDDsMdpa2HfkINTSsLvKunb",
  "currency": "MZN",
  "tax_percent": 1,
  "prices": [
    {
      "key": "key",
      "code": "COD-2026-000142",
      "name": "Ana Matsinhe",
      "kind": "connection_fee",
      "amount_cents": 125000,
      "taxable": true,
      "diameter_mm": 1,
      "one_time": true
    }
  ]
}

List every version of a request's quote

Logs

GET /service-requests/{id}/quotes

Returns every quote issued on the request, including superseded, expired and cancelled versions, in a data array without pagination. The request's quote state is refreshed first, so an overdue quote appears as expired. Returns 404 when the request is not in the caller's tenant; requires connections:read.

Parameters

idstring · path · required

ID of the service request whose quote versions are listed.

Returns

200 Quote versions, newest first

Show attributes
dataarray of ServiceQuote · required
Show child attributes
idstring · required
tenant_idstring · required
request_idstring · required
versioninteger · required
statusstring · required

one of issued, accepted, declined, superseded, expired, paid, cancelled

automaticboolean · required

Priced at once from the tariff without staff

site_visit_idstring · optional
tariff_version_idstring · optional
linesarray of ServiceQuoteLine · required
Show child attributes
idstring · required
positioninteger · required
kindstring · required

one of connection_fee, material, labour, other

charge_codestring · optional
descriptionstring · required
quantitynumber · required
list_price_centsinteger (int64) · optional

The tariff's unit price when the line came from it

unit_price_centsinteger (int64) · required
taxableboolean · required
total_centsinteger (int64) · required

Quantity times unit price

tax_centsinteger (int64) · required
adjustment_reasonstring · optional
subtotal_centsinteger (int64) · required
tax_centsinteger (int64) · required
total_centsinteger (int64) · required
currencystring · required
valid_untilstring (date-time) · required

Last day the quote can be accepted

notesstring · optional
issued_bystring · optional
issued_atstring (date-time) · required
accepted_atstring (date-time) · optional
declined_atstring (date-time) · optional
decline_notestring · optional
invoice_idstring · optional
invoice_numberstring · optional
payment_idstring · optional
receipt_numberstring · optional
paid_atstring (date-time) · optional
created_atstring (date-time) · optional
updated_atstring (date-time) · optional

Errors 403 · 404

Permissions connections:read · Roles: admin, analyst, customer_service, operations, owner, viewer

curl -X GET "$BUSINESS_API/service-requests/{id}/quotes" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "data": [
    {
      "id": "ser_2cAPViWrBMoJHYSb9GajpwyHJEy",
      "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
      "request_id": "req_2JrY4JziCp1C0bFCSLb4M37qGNH",
      "version": 1,
      "status": "issued",
      "automatic": true,
      "site_visit_id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
      "tariff_version_id": "tar_2TzCwDDsMdpa2HfkINTSsLvKunb",
      "lines": [
        {
          "id": "ser_2bBeKTRWGj1a0TJoARlcel7MIL7",
          "position": 1,
          "kind": "connection_fee",
          "charge_code": "CHA-2026-000142",
          "description": "Leitura confirmada no local.",
          "quantity": 1,
          "list_price_cents": 125000,
          "unit_price_cents": 125000,
          "taxable": true,
          "total_cents": 125000,
          "tax_cents": 1,
          "adjustment_reason": "adjustment reason"
        }
      ],
      "subtotal_cents": 125000,
      "tax_cents": 1,
      "total_cents": 125000,
      "currency": "MZN",
      "valid_until": "2026-11-19T09:30:00Z",
      "notes": "Leitura confirmada no local.",
      "issued_by": "issued by",
      "issued_at": "2026-11-19T09:30:00Z",
      "accepted_at": "2026-11-19T09:30:00Z",
      "declined_at": "2026-11-19T09:30:00Z",
      "decline_note": "decline note",
      "invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
      "invoice_number": "INV-2026-000142",
      "payment_id": "pay_2eUBfC8BJA6JLIoHrQwtN0GL1mW",
      "receipt_number": "REC-2026-000142",
      "paid_at": "2026-11-19T09:30:00Z",
      "created_at": "2026-11-19T09:30:00Z",
      "updated_at": "2026-11-19T09:30:00Z"
    }
  ]
}

Issue a quote, or a revised version, on a request

Logs

POST /service-requests/{id}/quotes

Lines come from the tariff catalogue (price key) or are free lines with their own price. A catalogue price changed, or a free line, needs adjustment_reason. The open version is superseded and stays visible; the request becomes quoted.

Parameters

idstring · path · required

ID of the service request to quote; it must be in a status that still accepts a quote.

Body application/json

linesarray of object · required
Show child attributes
charge_codestring · optional

A price key from quote-prices; omit for a free line

descriptionstring · optional
quantitynumber · optional

Defaults to 1

unit_price_centsinteger (int64) · optional

Overrides the tariff price (with a reason) or prices a free line

taxableboolean · optional

Free lines only; defaults to true

adjustment_reasonstring · optional
valid_untilstring (date) · optional

Defaults to 30 days from today

notesstring · optional
site_visit_idstring · optional

The visit this quote follows

Returns

201 Issued quote

Show attributes
idstring · required
tenant_idstring · required
request_idstring · required
versioninteger · required
statusstring · required

one of issued, accepted, declined, superseded, expired, paid, cancelled

automaticboolean · required

Priced at once from the tariff without staff

site_visit_idstring · optional
tariff_version_idstring · optional
linesarray of ServiceQuoteLine · required
Show child attributes
idstring · required
positioninteger · required
kindstring · required

one of connection_fee, material, labour, other

charge_codestring · optional
descriptionstring · required
quantitynumber · required
list_price_centsinteger (int64) · optional

The tariff's unit price when the line came from it

unit_price_centsinteger (int64) · required
taxableboolean · required
total_centsinteger (int64) · required

Quantity times unit price

tax_centsinteger (int64) · required
adjustment_reasonstring · optional
subtotal_centsinteger (int64) · required
tax_centsinteger (int64) · required
total_centsinteger (int64) · required
currencystring · required
valid_untilstring (date-time) · required

Last day the quote can be accepted

notesstring · optional
issued_bystring · optional
issued_atstring (date-time) · required
accepted_atstring (date-time) · optional
declined_atstring (date-time) · optional
decline_notestring · optional
invoice_idstring · optional
invoice_numberstring · optional
payment_idstring · optional
receipt_numberstring · optional
paid_atstring (date-time) · optional
created_atstring (date-time) · optional
updated_atstring (date-time) · optional

Errors 400 · 403 · 404

Permissions connections:write · Roles: admin, operations, owner

curl -X POST "$BUSINESS_API/service-requests/{id}/quotes" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "lines": [
    {
      "charge_code": "CHA-2026-000142",
      "description": "Leitura confirmada no local.",
      "quantity": 1,
      "unit_price_cents": 125000,
      "taxable": true,
      "adjustment_reason": "adjustment reason"
    }
  ],
  "valid_until": "2026-11-19",
  "notes": "Leitura confirmada no local.",
  "site_visit_id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL"
}'
Response 201
{
  "id": "ser_2cAPViWrBMoJHYSb9GajpwyHJEy",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "request_id": "req_2JrY4JziCp1C0bFCSLb4M37qGNH",
  "version": 1,
  "status": "issued",
  "automatic": true,
  "site_visit_id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
  "tariff_version_id": "tar_2TzCwDDsMdpa2HfkINTSsLvKunb",
  "lines": [
    {
      "id": "ser_2bBeKTRWGj1a0TJoARlcel7MIL7",
      "position": 1,
      "kind": "connection_fee",
      "charge_code": "CHA-2026-000142",
      "description": "Leitura confirmada no local.",
      "quantity": 1,
      "list_price_cents": 125000,
      "unit_price_cents": 125000,
      "taxable": true,
      "total_cents": 125000,
      "tax_cents": 1,
      "adjustment_reason": "adjustment reason"
    }
  ],
  "subtotal_cents": 125000,
  "tax_cents": 1,
  "total_cents": 125000,
  "currency": "MZN",
  "valid_until": "2026-11-19T09:30:00Z",
  "notes": "Leitura confirmada no local.",
  "issued_by": "issued by",
  "issued_at": "2026-11-19T09:30:00Z",
  "accepted_at": "2026-11-19T09:30:00Z",
  "declined_at": "2026-11-19T09:30:00Z",
  "decline_note": "decline note",
  "invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
  "invoice_number": "INV-2026-000142",
  "payment_id": "pay_2eUBfC8BJA6JLIoHrQwtN0GL1mW",
  "receipt_number": "REC-2026-000142",
  "paid_at": "2026-11-19T09:30:00Z",
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z"
}

List the working days a site visit can be booked on

Logs

GET /service-requests/{id}/visit-slots

The next working days from tomorrow in the tenant calendar; weekends and holidays are skipped.

Parameters

idstring · path · required

ID of the service request a visit slot is being chosen for.

Returns

200 Offered days

Show attributes
datesarray of string · required

Errors 403 · 404

Permissions connections:read · Roles: admin, analyst, customer_service, operations, owner, viewer

curl -X GET "$BUSINESS_API/service-requests/{id}/visit-slots" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "dates": [
    "2026-11-19"
  ]
}

Book, or move, a site visit for a request still being priced

Logs

POST /service-requests/{id}/site-visits

A visit still to happen is cancelled and an unanswered quote superseded; the request becomes visit_scheduled.

Parameters

idstring · path · required

ID of the service request the site visit is booked for.

Body application/json

datestring (date) · required

One of the offered days

notesstring · optional

Returns

201 Booked visit

Show attributes
idstring · required
tenant_idstring · required
request_idstring · required
statusstring · required

one of scheduled, completed, cancelled

visit_datestring (date) · required
booked_bystring · required

one of consumer, staff

notesstring · optional
outcomestring · optional
quote_idstring · optional
completed_atstring (date-time) · optional
cancelled_atstring (date-time) · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required

Errors 400 · 403 · 404

Permissions connections:write · Roles: admin, operations, owner

curl -X POST "$BUSINESS_API/service-requests/{id}/site-visits" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "date": "2026-11-19",
  "notes": "Leitura confirmada no local."
}'
Response 201
{
  "id": "sit_2ljUKXviQDVcG3dOWH1ysvVGYfL",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "request_id": "req_2JrY4JziCp1C0bFCSLb4M37qGNH",
  "status": "scheduled",
  "visit_date": "2026-11-19",
  "booked_by": "consumer",
  "notes": "Leitura confirmada no local.",
  "outcome": "outcome",
  "quote_id": "quo_26mh1wUlhIGz1c4BTWQl9M2dDyI",
  "completed_at": "2026-11-19T09:30:00Z",
  "cancelled_at": "2026-11-19T09:30:00Z",
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z"
}