PT EN

Estimativas

URL base: $PUBLIC_API

O objecto

pricedboolean · obrigatório

False when the utility has not configured a connection price

min_centsinteger (int64) · opcional
max_centsinteger (int64) · opcional
currencystring · opcional
message_codestring · obrigatório

um de estimate.priced, estimate.range, estimate.unpriced

messagestring · obrigatório
Operações
O objecto
{
  "priced": true,
  "min_cents": 1,
  "max_cents": 1,
  "currency": "MZN",
  "message_code": "estimate.priced",
  "message": "Leitura confirmada no local."
}

Estimar o preço de uma ligação

Registos

POST /estimates

Priced from the utility's configured connection fee (tariff charge components with accounting_role connection_fee). Without a configured price the answer has no amount and says the utility will quote (priced false).

Corpo application/json

tenant_idstring · opcional
localitystring · opcional
distance_metersinteger · opcional
connection_typestring · opcional

um de residential, commercial, industrial, institutional, government

challenge_tokenstring · opcional

Bot-challenge token when security.challenge is enabled (anonymous callers). Only UI requests (browser headers, the dashboard, or X-Client mobile or desktop) are challenged; API requests never are.

Devolve

200 Estimate

Mostrar atributos
pricedboolean · obrigatório

False when the utility has not configured a connection price

min_centsinteger (int64) · opcional
max_centsinteger (int64) · opcional
currencystring · opcional
message_codestring · obrigatório

um de estimate.priced, estimate.range, estimate.unpriced

messagestring · obrigatório

Erros 400 · 403

curl -X POST "$PUBLIC_API/estimates" \
  -H "Content-Type: application/json" \
  -d '{
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "locality": "locality",
  "distance_meters": 1,
  "connection_type": "residential",
  "challenge_token": "challenge token"
}'
Resposta 200
{
  "priced": true,
  "min_cents": 1,
  "max_cents": 1,
  "currency": "MZN",
  "message_code": "estimate.priced",
  "message": "Leitura confirmada no local."
}