PT EN

Liquidações

URL base: $BUSINESS_API

Listar liquidações

Registos

GET /reconciliation-settlements

Returns a cursor-paginated page of settlements, the statements issued to operators when a confirmed reconciliation is settled. Each shows the expected amount, commission, amount remitted and the balance still owed, in cents. Filter with status, meter_id or account_id 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-settlements" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200

OK

Obter uma liquidação

Registos

GET /reconciliation-settlements/{id}

Returns one settlement with its number, reconciliation, contract, meter, expected, commission, remitted and balance amounts in cents, currency and issue details. A settlement that does not exist in the tenant returns 404. Requires business:reconciliations:read.

Devolve

200 OK

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

curl -X GET "$BUSINESS_API/reconciliation-settlements/{id}" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200

OK

Descarregar uma liquidação em PDF

Registos

GET /reconciliation-settlements/{id}/statement.pdf

Renders a settlement statement as a PDF download (Content-Disposition attachment) showing the operator, the meter serial, the reconciled period and the expected, commission, remitted and balance amounts. The settlement, its contract and its reconciliation are read with the caller's own access. An unknown settlement returns 404 and missing read access returns 403.

Parâmetros

layoutstring · consulta · opcional · predefinição a4

Page format. mobile is one narrow column sized to its content, for reading on a phone. An unknown value renders A4.

um de a4, mobile

Devolve

200 OK

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

curl -X GET "$BUSINESS_API/reconciliation-settlements/{id}/statement.pdf" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200

OK