PT EN

Pedidos de serviço

URL base: $CONSUMER_API

O objecto

idstring · obrigatório
tenant_idstring · obrigatório
phonestring · obrigatório
full_namestring · opcional
addressstring · obrigatório
plus_codestring · opcional
localitystring · opcional
landmarkstring · opcional
service_typestring · obrigatório

um de new_connection

categorystring · obrigatório

um de residential, commercial, industrial, institutional, government

statusstring · obrigatório

um de submitted, accepted, visit_scheduled, quoted, payment_pending, scheduled, completed, declined, withdrawn

pricedboolean · obrigatório
estimate_min_centsinteger (int64) · opcional
estimate_max_centsinteger (int64) · opcional
currencystring · opcional
decline_reasonstring · opcional

Code from the tenant's configured decline reasons

decline_reason_labelstring · opcional

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

decline_notestring · opcional
account_idstring · opcional

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

account_numberstring · opcional

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

account_holder_namestring · opcional

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

customer_idstring · opcional
customer_namestring · opcional

Display name of the referenced customer. Omitted when unknown.

property_idstring · opcional
property_addressstring · opcional

Address line of the referenced property. Omitted when unknown.

property_holder_namestring · opcional

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

connection_idstring · opcional
connection_holder_namestring · opcional

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

connection_statusstring · opcional
quote_idstring · opcional

The current quote

site_visit_idstring · opcional

The current site visit

invoice_idstring · opcional

Invoice the accepted quote is paid through

payment_idstring · opcional
receipt_numberstring · opcional
work_order_idstring · opcional

Installation work order booked once paid

installation_datestring (date) · opcional
quoteobject · opcional
Mostrar atributos filhos
idstring · obrigatório
tenant_idstring · obrigatório
request_idstring · obrigatório
versioninteger · obrigatório
statusstring · obrigatório

um de issued, accepted, declined, superseded, expired, paid, cancelled

automaticboolean · obrigatório

Priced at once from the tariff without staff

site_visit_idstring · opcional
tariff_version_idstring · opcional
linesarray of ServiceQuoteLine · obrigatório
Mostrar atributos filhos
idstring · obrigatório
positioninteger · obrigatório
kindstring · obrigatório

um de connection_fee, material, labour, other

charge_codestring · opcional
descriptionstring · obrigatório
quantitynumber · obrigatório
list_price_centsinteger (int64) · opcional

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

unit_price_centsinteger (int64) · obrigatório
taxableboolean · obrigatório
total_centsinteger (int64) · obrigatório

Quantity times unit price

tax_centsinteger (int64) · obrigatório
adjustment_reasonstring · opcional
subtotal_centsinteger (int64) · obrigatório
tax_centsinteger (int64) · obrigatório
total_centsinteger (int64) · obrigatório
currencystring · obrigatório
valid_untilstring (date-time) · obrigatório

Last day the quote can be accepted

notesstring · opcional
issued_bystring · opcional
issued_atstring (date-time) · obrigatório
accepted_atstring (date-time) · opcional
declined_atstring (date-time) · opcional
decline_notestring · opcional
invoice_idstring · opcional
invoice_numberstring · opcional
payment_idstring · opcional
receipt_numberstring · opcional
paid_atstring (date-time) · opcional
created_atstring (date-time) · opcional
updated_atstring (date-time) · opcional
site_visitobject · opcional
Mostrar atributos filhos
idstring · obrigatório
tenant_idstring · obrigatório
request_idstring · obrigatório
statusstring · obrigatório

um de scheduled, completed, cancelled

visit_datestring (date) · obrigatório
booked_bystring · obrigatório

um de consumer, staff

notesstring · opcional
outcomestring · opcional
quote_idstring · opcional
completed_atstring (date-time) · opcional
cancelled_atstring (date-time) · opcional
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
can_book_visitboolean · opcional

The requester may book a site visit from the offered days

decided_bystring · opcional
decided_atstring (date-time) · opcional
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
O objecto
{
  "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"
}

Listar pedidos de serviço

Registos

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.

Parâmetros

limitinteger · consulta · opcional

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

afterstring · consulta · opcional

Opaque cursor returned by the previous page.

Devolve

200 The caller's requests across utilities

Mostrar atributos
dataarray of ServiceRequest · obrigatório
Mostrar atributos filhos
idstring · obrigatório
tenant_idstring · obrigatório
phonestring · obrigatório
full_namestring · opcional
addressstring · obrigatório
plus_codestring · opcional
localitystring · opcional
landmarkstring · opcional
service_typestring · obrigatório

um de new_connection

categorystring · obrigatório

um de residential, commercial, industrial, institutional, government

statusstring · obrigatório

um de submitted, accepted, visit_scheduled, quoted, payment_pending, scheduled, completed, declined, withdrawn

pricedboolean · obrigatório
estimate_min_centsinteger (int64) · opcional
estimate_max_centsinteger (int64) · opcional
currencystring · opcional
decline_reasonstring · opcional

Code from the tenant's configured decline reasons

decline_reason_labelstring · opcional

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

decline_notestring · opcional
account_idstring · opcional

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

account_numberstring · opcional

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

account_holder_namestring · opcional

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

customer_idstring · opcional
customer_namestring · opcional

Display name of the referenced customer. Omitted when unknown.

property_idstring · opcional
property_addressstring · opcional

Address line of the referenced property. Omitted when unknown.

property_holder_namestring · opcional

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

connection_idstring · opcional
connection_holder_namestring · opcional

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

connection_statusstring · opcional
quote_idstring · opcional

The current quote

site_visit_idstring · opcional

The current site visit

invoice_idstring · opcional

Invoice the accepted quote is paid through

payment_idstring · opcional
receipt_numberstring · opcional
work_order_idstring · opcional

Installation work order booked once paid

installation_datestring (date) · opcional
quoteobject · opcional
Mostrar atributos filhos
idstring · obrigatório
tenant_idstring · obrigatório
request_idstring · obrigatório
versioninteger · obrigatório
statusstring · obrigatório

um de issued, accepted, declined, superseded, expired, paid, cancelled

automaticboolean · obrigatório

Priced at once from the tariff without staff

site_visit_idstring · opcional
tariff_version_idstring · opcional
linesarray of ServiceQuoteLine · obrigatório
Mostrar atributos filhos
idstring · obrigatório
positioninteger · obrigatório
kindstring · obrigatório

um de connection_fee, material, labour, other

charge_codestring · opcional
descriptionstring · obrigatório
quantitynumber · obrigatório
list_price_centsinteger (int64) · opcional

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

unit_price_centsinteger (int64) · obrigatório
taxableboolean · obrigatório
total_centsinteger (int64) · obrigatório

Quantity times unit price

tax_centsinteger (int64) · obrigatório
adjustment_reasonstring · opcional
subtotal_centsinteger (int64) · obrigatório
tax_centsinteger (int64) · obrigatório
total_centsinteger (int64) · obrigatório
currencystring · obrigatório
valid_untilstring (date-time) · obrigatório

Last day the quote can be accepted

notesstring · opcional
issued_bystring · opcional
issued_atstring (date-time) · obrigatório
accepted_atstring (date-time) · opcional
declined_atstring (date-time) · opcional
decline_notestring · opcional
invoice_idstring · opcional
invoice_numberstring · opcional
payment_idstring · opcional
receipt_numberstring · opcional
paid_atstring (date-time) · opcional
created_atstring (date-time) · opcional
updated_atstring (date-time) · opcional
site_visitobject · opcional
Mostrar atributos filhos
idstring · obrigatório
tenant_idstring · obrigatório
request_idstring · obrigatório
statusstring · obrigatório

um de scheduled, completed, cancelled

visit_datestring (date) · obrigatório
booked_bystring · obrigatório

um de consumer, staff

notesstring · opcional
outcomestring · opcional
quote_idstring · opcional
completed_atstring (date-time) · opcional
cancelled_atstring (date-time) · opcional
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
can_book_visitboolean · opcional

The requester may book a site visit from the offered days

decided_bystring · opcional
decided_atstring (date-time) · opcional
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
has_moreboolean · obrigatório
next_cursorstring · opcional

Erros 401

curl -X GET "$CONSUMER_API/service-requests" \
  -H "Authorization: Bearer sk_test_..."
Resposta 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"
}

Obter um pedido de serviço

Registos

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.

Parâmetros

idstring · caminho · obrigatório

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

Devolve

200 The request, including a private decline reason

Mostrar atributos
idstring · obrigatório
tenant_idstring · obrigatório
phonestring · obrigatório
full_namestring · opcional
addressstring · obrigatório
plus_codestring · opcional
localitystring · opcional
landmarkstring · opcional
service_typestring · obrigatório

um de new_connection

categorystring · obrigatório

um de residential, commercial, industrial, institutional, government

statusstring · obrigatório

um de submitted, accepted, visit_scheduled, quoted, payment_pending, scheduled, completed, declined, withdrawn

pricedboolean · obrigatório
estimate_min_centsinteger (int64) · opcional
estimate_max_centsinteger (int64) · opcional
currencystring · opcional
decline_reasonstring · opcional

Code from the tenant's configured decline reasons

decline_reason_labelstring · opcional

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

decline_notestring · opcional
account_idstring · opcional

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

account_numberstring · opcional

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

account_holder_namestring · opcional

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

customer_idstring · opcional
customer_namestring · opcional

Display name of the referenced customer. Omitted when unknown.

property_idstring · opcional
property_addressstring · opcional

Address line of the referenced property. Omitted when unknown.

property_holder_namestring · opcional

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

connection_idstring · opcional
connection_holder_namestring · opcional

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

connection_statusstring · opcional
quote_idstring · opcional

The current quote

site_visit_idstring · opcional

The current site visit

invoice_idstring · opcional

Invoice the accepted quote is paid through

payment_idstring · opcional
receipt_numberstring · opcional
work_order_idstring · opcional

Installation work order booked once paid

installation_datestring (date) · opcional
quoteobject · opcional
Mostrar atributos filhos
idstring · obrigatório
tenant_idstring · obrigatório
request_idstring · obrigatório
versioninteger · obrigatório
statusstring · obrigatório

um de issued, accepted, declined, superseded, expired, paid, cancelled

automaticboolean · obrigatório

Priced at once from the tariff without staff

site_visit_idstring · opcional
tariff_version_idstring · opcional
linesarray of ServiceQuoteLine · obrigatório
Mostrar atributos filhos
idstring · obrigatório
positioninteger · obrigatório
kindstring · obrigatório

um de connection_fee, material, labour, other

charge_codestring · opcional
descriptionstring · obrigatório
quantitynumber · obrigatório
list_price_centsinteger (int64) · opcional

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

unit_price_centsinteger (int64) · obrigatório
taxableboolean · obrigatório
total_centsinteger (int64) · obrigatório

Quantity times unit price

tax_centsinteger (int64) · obrigatório
adjustment_reasonstring · opcional
subtotal_centsinteger (int64) · obrigatório
tax_centsinteger (int64) · obrigatório
total_centsinteger (int64) · obrigatório
currencystring · obrigatório
valid_untilstring (date-time) · obrigatório

Last day the quote can be accepted

notesstring · opcional
issued_bystring · opcional
issued_atstring (date-time) · obrigatório
accepted_atstring (date-time) · opcional
declined_atstring (date-time) · opcional
decline_notestring · opcional
invoice_idstring · opcional
invoice_numberstring · opcional
payment_idstring · opcional
receipt_numberstring · opcional
paid_atstring (date-time) · opcional
created_atstring (date-time) · opcional
updated_atstring (date-time) · opcional
site_visitobject · opcional
Mostrar atributos filhos
idstring · obrigatório
tenant_idstring · obrigatório
request_idstring · obrigatório
statusstring · obrigatório

um de scheduled, completed, cancelled

visit_datestring (date) · obrigatório
booked_bystring · obrigatório

um de consumer, staff

notesstring · opcional
outcomestring · opcional
quote_idstring · opcional
completed_atstring (date-time) · opcional
cancelled_atstring (date-time) · opcional
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
can_book_visitboolean · opcional

The requester may book a site visit from the offered days

decided_bystring · opcional
decided_atstring (date-time) · opcional
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório

Erros 404

curl -X GET "$CONSUMER_API/service-requests/{id}" \
  -H "Authorization: Bearer sk_test_..."
Resposta 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"
}

Desistir de um pedido de serviço

Registos

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.

Parâmetros

idstring · caminho · obrigatório

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

Devolve

200 Withdrawn request

Mostrar atributos
idstring · obrigatório
tenant_idstring · obrigatório
phonestring · obrigatório
full_namestring · opcional
addressstring · obrigatório
plus_codestring · opcional
localitystring · opcional
landmarkstring · opcional
service_typestring · obrigatório

um de new_connection

categorystring · obrigatório

um de residential, commercial, industrial, institutional, government

statusstring · obrigatório

um de submitted, accepted, visit_scheduled, quoted, payment_pending, scheduled, completed, declined, withdrawn

pricedboolean · obrigatório
estimate_min_centsinteger (int64) · opcional
estimate_max_centsinteger (int64) · opcional
currencystring · opcional
decline_reasonstring · opcional

Code from the tenant's configured decline reasons

decline_reason_labelstring · opcional

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

decline_notestring · opcional
account_idstring · opcional

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

account_numberstring · opcional

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

account_holder_namestring · opcional

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

customer_idstring · opcional
customer_namestring · opcional

Display name of the referenced customer. Omitted when unknown.

property_idstring · opcional
property_addressstring · opcional

Address line of the referenced property. Omitted when unknown.

property_holder_namestring · opcional

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

connection_idstring · opcional
connection_holder_namestring · opcional

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

connection_statusstring · opcional
quote_idstring · opcional

The current quote

site_visit_idstring · opcional

The current site visit

invoice_idstring · opcional

Invoice the accepted quote is paid through

payment_idstring · opcional
receipt_numberstring · opcional
work_order_idstring · opcional

Installation work order booked once paid

installation_datestring (date) · opcional
quoteobject · opcional
Mostrar atributos filhos
idstring · obrigatório
tenant_idstring · obrigatório
request_idstring · obrigatório
versioninteger · obrigatório
statusstring · obrigatório

um de issued, accepted, declined, superseded, expired, paid, cancelled

automaticboolean · obrigatório

Priced at once from the tariff without staff

site_visit_idstring · opcional
tariff_version_idstring · opcional
linesarray of ServiceQuoteLine · obrigatório
Mostrar atributos filhos
idstring · obrigatório
positioninteger · obrigatório
kindstring · obrigatório

um de connection_fee, material, labour, other

charge_codestring · opcional
descriptionstring · obrigatório
quantitynumber · obrigatório
list_price_centsinteger (int64) · opcional

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

unit_price_centsinteger (int64) · obrigatório
taxableboolean · obrigatório
total_centsinteger (int64) · obrigatório

Quantity times unit price

tax_centsinteger (int64) · obrigatório
adjustment_reasonstring · opcional
subtotal_centsinteger (int64) · obrigatório
tax_centsinteger (int64) · obrigatório
total_centsinteger (int64) · obrigatório
currencystring · obrigatório
valid_untilstring (date-time) · obrigatório

Last day the quote can be accepted

notesstring · opcional
issued_bystring · opcional
issued_atstring (date-time) · obrigatório
accepted_atstring (date-time) · opcional
declined_atstring (date-time) · opcional
decline_notestring · opcional
invoice_idstring · opcional
invoice_numberstring · opcional
payment_idstring · opcional
receipt_numberstring · opcional
paid_atstring (date-time) · opcional
created_atstring (date-time) · opcional
updated_atstring (date-time) · opcional
site_visitobject · opcional
Mostrar atributos filhos
idstring · obrigatório
tenant_idstring · obrigatório
request_idstring · obrigatório
statusstring · obrigatório

um de scheduled, completed, cancelled

visit_datestring (date) · obrigatório
booked_bystring · obrigatório

um de consumer, staff

notesstring · opcional
outcomestring · opcional
quote_idstring · opcional
completed_atstring (date-time) · opcional
cancelled_atstring (date-time) · opcional
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório
can_book_visitboolean · opcional

The requester may book a site visit from the offered days

decided_bystring · opcional
decided_atstring (date-time) · opcional
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório

Erros 400 · 404

curl -X POST "$CONSUMER_API/service-requests/{id}/withdraw" \
  -H "Authorization: Bearer sk_test_..."
Resposta 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"
}

Listar orçamentos de um pedido

Registos

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.

Parâmetros

idstring · caminho · obrigatório

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

Devolve

200 Quote versions, newest first

Mostrar atributos
dataarray of ServiceQuote · obrigatório
Mostrar atributos filhos
idstring · obrigatório
tenant_idstring · obrigatório
request_idstring · obrigatório
versioninteger · obrigatório
statusstring · obrigatório

um de issued, accepted, declined, superseded, expired, paid, cancelled

automaticboolean · obrigatório

Priced at once from the tariff without staff

site_visit_idstring · opcional
tariff_version_idstring · opcional
linesarray of ServiceQuoteLine · obrigatório
Mostrar atributos filhos
idstring · obrigatório
positioninteger · obrigatório
kindstring · obrigatório

um de connection_fee, material, labour, other

charge_codestring · opcional
descriptionstring · obrigatório
quantitynumber · obrigatório
list_price_centsinteger (int64) · opcional

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

unit_price_centsinteger (int64) · obrigatório
taxableboolean · obrigatório
total_centsinteger (int64) · obrigatório

Quantity times unit price

tax_centsinteger (int64) · obrigatório
adjustment_reasonstring · opcional
subtotal_centsinteger (int64) · obrigatório
tax_centsinteger (int64) · obrigatório
total_centsinteger (int64) · obrigatório
currencystring · obrigatório
valid_untilstring (date-time) · obrigatório

Last day the quote can be accepted

notesstring · opcional
issued_bystring · opcional
issued_atstring (date-time) · obrigatório
accepted_atstring (date-time) · opcional
declined_atstring (date-time) · opcional
decline_notestring · opcional
invoice_idstring · opcional
invoice_numberstring · opcional
payment_idstring · opcional
receipt_numberstring · opcional
paid_atstring (date-time) · opcional
created_atstring (date-time) · opcional
updated_atstring (date-time) · opcional

Erros 404

curl -X GET "$CONSUMER_API/service-requests/{id}/quotes" \
  -H "Authorization: Bearer sk_test_..."
Resposta 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"
    }
  ]
}

Listar dias disponíveis para visita

Registos

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

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

Parâmetros

idstring · caminho · obrigatório

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.

Devolve

200 Offered days

Mostrar atributos
datesarray of string · obrigatório

Erros 404

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

Marcar uma visita ao local

Registos

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.

Parâmetros

idstring · caminho · obrigatório

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

Corpo application/json

datestring (date) · obrigatório

One of the offered days

notesstring · opcional

Devolve

201 Booked visit

Mostrar atributos
idstring · obrigatório
tenant_idstring · obrigatório
request_idstring · obrigatório
statusstring · obrigatório

um de scheduled, completed, cancelled

visit_datestring (date) · obrigatório
booked_bystring · obrigatório

um de consumer, staff

notesstring · opcional
outcomestring · opcional
quote_idstring · opcional
completed_atstring (date-time) · opcional
cancelled_atstring (date-time) · opcional
created_atstring (date-time) · obrigatório
updated_atstring (date-time) · obrigatório

Erros 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."
}'
Resposta 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"
}