Skip to main content
GET
/
v1
/
settlement
Settlement summary
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox.api.enfinitos.com/v1/settlement', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "ok": true,
  "data": {
    "settlement": {
      "schemaVersion": "<string>",
      "orgId": "<string>",
      "periodStart": "2023-11-07T05:31:56Z",
      "periodEnd": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "meterGross": {},
      "lines": [
        {
          "idemKey": "<string>",
          "meterRecordIdemKey": "<string>",
          "share": "<string>",
          "ledgerAccountCode": "<string>",
          "amountCents": 123,
          "currency": "<string>"
        }
      ],
      "totals": {
        "grossCents": 123,
        "netToTenantCents": 123,
        "platformFeeCents": 123,
        "vatCents": 123,
        "passThroughFeeLedgerCodes": [
          "<string>"
        ]
      }
    }
  },
  "contractVersion": "<string>"
}

Authorizations

Authorization
string
header
required

API key sent as Authorization: Bearer <api-key>.

Query Parameters

periodStart
string<date-time>

ISO-8601 inclusive window start. Defaults to the tenant's createdAt.

periodEnd
string<date-time>

ISO-8601 exclusive window end. Defaults to now.

currency
string
default:GBP

3-letter ISO 4217 code for the settlement output. Defaults to GBP.

Pattern: ^[A-Z]{3}$

Response

The settlement summary.

ok
boolean
required
data
object
required

Route-specific payload. Operation responses refine this.

contractVersion
string
required
Allowed value: "v1.0"