PT EN

Tarifas de reconciliação

URL base: $BUSINESS_API

Listar tarifas de reconciliação

Registos

GET /reconciliation-tariffs

Returns a cursor-paginated page of reconciliation tariffs, which set the retail price per unit volume, the utility's price per cubic metre and the variance tolerance used when reconciling metered resale. Filter with status and page with limit and after. Requires business:reconciliations:read.

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 OK

Permissões business:reconciliations:read · Funções: admin, analyst, customer_service, finance, operations, owner, viewer

curl -X GET "$BUSINESS_API/reconciliation-tariffs" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200

OK

Criar uma tarifa de reconciliação

Registos

POST /reconciliation-tariffs

Creates an active reconciliation tariff from effective_from onwards; settlements use the latest active tariff in effect at the reconciled period's end. name, currency, effective_from and a positive retail_cents_per_unit are required, unit_litres defaults to 1000, and tolerance_bp must be between 0 and 10000; invalid values return 400. When utility_cents_per_m3 is omitted, wholesale_cents_per_m3 is used in its place. Requires business:reconciliations:settle.

Devolve

201 Reconciliation pricing tariff created

Mostrar atributos
idstring · obrigatório
tenant_idstring · obrigatório
namestring · obrigatório
unit_litresinteger (int64) · obrigatório
retail_cents_per_unitinteger (int64) · obrigatório
utility_cents_per_m3integer (int64) · obrigatório
tolerance_bpinteger · obrigatório
currencystring · obrigatório
effective_fromstring (date-time) · obrigatório
statusstring · obrigatório

Permissões business:reconciliations:settle · Funções: admin, finance, owner

curl -X POST "$BUSINESS_API/reconciliation-tariffs" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 201
{
  "id": "idx_2xBW8Tr0oR5YsrNoIdzQO7t4Gjn",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "name": "Ana Matsinhe",
  "unit_litres": 1,
  "retail_cents_per_unit": 1,
  "utility_cents_per_m3": 1,
  "tolerance_bp": 1,
  "currency": "MZN",
  "effective_from": "2026-11-19T09:30:00Z",
  "status": "active"
}