Listar tarifas
RegistosGET /tariffs
Returns the tenant's tariff schedules in cursor pages (limit up to 100, 20 by default, after for the next page), including drafts and superseded versions unless filtered. A free-text q parameter narrows the list further. Requires tariffs:read.
Parâmetros
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
categoryReturns only tariffs for this customer category: residential, commercial, industrial, institutional or government.
um de
residential,commercial,industrial,institutional,governmentstatusReturns only tariffs in this status: draft, active or superseded.
um de
draft,active,superseded
Devolve
200 Tariffs in the utility tenant
Mostrar atributos
dataMostrar atributos filhos
idtenant_idcodenamecategoryum de
residential,commercial,industrial,institutional,governmentcurrencyminor_unitsfixed_fee_centsmin_consumption_m3minimum_charge_centssanitation_surcharge_percenttax_percenttiersMostrar atributos filhos
tier_numbermin_m3max_m3Zero means unbounded
rate_per_m3_centsvolume_start_lvolume_end_l
fixed_chargesMostrar atributos filhos
charge_codedescriptiondiameter_mmamount_minor
charge_componentsMostrar atributos filhos
codenamedescriptionlabelskindum de
fixed,percentageamount_minorrate_basis_pointsrate_percentbasisum de
service_subtotaltaxablesort_ordercadenceum de
every_bill,every_n_periods,one_timeinterval_periodsanchor_dateeffective_fromeffective_topartial_period_policyum de
full,prorate,skipskipped_cycle_policyum de
skipactivediameter_mmservice_area_idpayment_termsum de
inherit_invoiceaccounting_role
effective_fromeffective_tostatusum de
draft,active,supersededcreated_atupdated_at
has_morenext_cursor
Erros 403
Permissões tariffs:read · Funções: admin, analyst, billing_clerk, customer_service, finance, owner, viewer
curl -X GET "$BUSINESS_API/tariffs" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$BUSINESS_API/tariffs", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/tariffs",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/tariffs", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"id": "uti_2lVUY3v2KN5iaJpucZDwaxd8of9",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"code": "COD-2026-000142",
"name": "Ana Matsinhe",
"category": "residential",
"currency": "MZN",
"minor_units": 1,
"fixed_fee_cents": 125000,
"min_consumption_m3": 13.42,
"minimum_charge_cents": 1,
"sanitation_surcharge_percent": 1,
"tax_percent": 1,
"tiers": [
{
"tier_number": 1,
"min_m3": 1,
"max_m3": 1,
"rate_per_m3_cents": 1,
"volume_start_l": 1342,
"volume_end_l": 1342
}
],
"fixed_charges": [
{
"charge_code": "CHA-2026-000142",
"description": "Leitura confirmada no local.",
"diameter_mm": 1,
"amount_minor": 125000
}
],
"charge_components": [
{
"code": "COD-2026-000142",
"name": "Ana Matsinhe",
"description": "Leitura confirmada no local.",
"labels": {
"key": "value"
},
"kind": "fixed",
"amount_minor": 125000,
"rate_basis_points": 1,
"rate_percent": 1,
"basis": "service_subtotal",
"taxable": true,
"sort_order": 1,
"cadence": "every_bill",
"interval_periods": 1,
"anchor_date": "2026-11-19T09:30:00Z",
"effective_from": "2026-11-19T09:30:00Z",
"effective_to": "2026-11-19T09:30:00Z",
"partial_period_policy": "full",
"skipped_cycle_policy": "skip",
"active": true,
"diameter_mm": 1,
"service_area_id": "ser_23fmkpfkC17kSVJ2spjyiBbOED9",
"payment_terms": "inherit_invoice",
"accounting_role": "accounting role"
}
],
"effective_from": "2026-11-19T09:30:00Z",
"effective_to": "2026-11-19T09:30:00Z",
"status": "draft",
"created_at": "2026-11-19T09:30:00Z",
"updated_at": "2026-11-19T09:30:00Z"
}
],
"has_more": true,
"next_cursor": "next cursor"
}