Service requests

Base URL: $CONSUMER_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 signed-in person's own service requests

Logs

GET /service-requests

Returns the requests the signed-in identity submitted, across every utility, including requests that have no account yet. Each item shows its current status, any account or connection it led to, and can_book_visit when the request is waiting for a site visit to be booked. Results are cursor-paginated with limit (default 20, at most 100) and after.

Parameters

limitinteger · query · optional

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

afterstring · query · optional

Opaque cursor returned by the previous page.

Returns

200 The caller's requests across utilities

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 401

curl -X GET "$CONSUMER_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 one of the signed-in person's own service requests

Logs

GET /service-requests/{id}

Returns the request with its current status, refreshed before it is returned (for example, a quote whose invoice has been paid moves the request forward). A request that belongs to another identity answers 404, never 403.

Parameters

idstring · path · required

Identifier of the service request; only requests submitted by the signed-in identity are found.

Returns

200 The request, including a private decline reason

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 404

curl -X GET "$CONSUMER_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"
}

Withdraw one of the signed-in person's open service requests

Logs

POST /service-requests/{id}/withdraw

Moves the request to withdrawn and closes everything open on it: an issued quote is cancelled, an accepted quote has its invoice voided, a scheduled site visit is cancelled and a connection that is not yet active is retired. A request can be withdrawn at any point before its quote is paid; once it is scheduled, completed, declined or already withdrawn the call answers 400. Returns the updated request.

Parameters

idstring · path · required

Identifier of one of the signed-in identity's own open service requests.

Returns

200 Withdrawn 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 · 404

curl -X POST "$CONSUMER_API/service-requests/{id}/withdraw" \
  -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"
}

List the quotes of one of the signed-in person's requests

Logs

GET /service-requests/{id}/quotes

Returns every quote version the utility has issued for the request, including superseded, declined, expired and accepted ones, so the caller can see the history and find the open quote to accept or decline. The response wraps the list in data and is not paginated. A request that belongs to another identity answers 404.

Parameters

idstring · path · required

Identifier of one of the signed-in identity's own service requests.

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 404

curl -X GET "$CONSUMER_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"
    }
  ]
}

List the days the requester can choose for a site visit

Logs

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

Empty unless can_book_visit is true on the request (a price that depends on the site).

Parameters

idstring · path · required

Identifier of one of the signed-in identity's own service requests; when the request does not need a visit the response holds an empty list of dates.

Returns

200 Offered days

Show attributes
datesarray of string · required

Errors 404

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

Book a site visit on one of the offered days

Logs

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

Books a site visit so the utility can price a request whose estimate is a range rather than a fixed amount; the date must be one of the days returned by the visit-slots operation, and notes are limited to 1000 characters. Booking cancels any visit still scheduled on the request and supersedes an open quote, and the request moves to visit_scheduled. Returns 201 with the visit; a request that does not need a visit now (already priced exactly, or past the submitted and accepted states) answers 400.

Parameters

idstring · path · required

Identifier of one of the signed-in identity's own service requests that is waiting for a visit to be booked.

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 · 404

curl -X POST "$CONSUMER_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"
}