---
id: "formance"
type: "component"
kind: "ledger"
provider: "default"
category: "data"
docs: "https://docs.formance.com/ledger/"
url: "https://localhost:3000/catalogue/components/formance"
---

# Formance Ledger

Programmable double-entry ledger with an immutable transaction log and Numscript.

| | |
|---|---|
| Provider | [default](https://localhost:3000/catalogue?provider=default) |
| Kind | [Ledger](https://localhost:3000/catalogue/kinds/ledger) |
| Category | Data |
| Official docs | [https://docs.formance.com/ledger/](https://docs.formance.com/ledger/) |

## Properties

| property | type | values | required | kind default | this component |
|---|---|---|---|---|---|
| `appendOnly` | boolean | — | no | true | **true** |
| `backingStore` | ref | — | no | — | inherited |
| `doubleEntry` | boolean | — | no | true | **true** |
| `hosting` | enum | `self-hosted`, `formance-cloud` | no | "self-hosted" | inherited |
| `idempotencyKeys` | boolean | — | no | true | inherited |
| `indexConsistency` (advanced) | enum | `strong`, `eventual` | no | "strong" | **"strong"** |
| `managed` | boolean | — | no | false | **false** |
| `sealed` (advanced) | boolean | — | no | false | inherited |
| `tamperEvident` | boolean | — | no | false | inherited |
| `tiering` (advanced) | boolean | — | no | false | inherited |

Bold values are the ones this component pins.

## Rules that apply · 0

No rule selects this kind or its category.

## Other products of the same kind · 10

- [Blockchain as a Service](https://localhost:3000/catalogue/components/alibaba-blockchain-as-a-service.md) `alibaba-blockchain-as-a-service` — alibabacloud
- [Amazon Managed Blockchain network](https://localhost:3000/catalogue/components/aws-managed-blockchain.md) `aws-managed-blockchain` — aws
- [Amazon QLDB](https://localhost:3000/catalogue/components/qldb.md) `qldb` — aws
- [Azure confidential ledger](https://localhost:3000/catalogue/components/azure-confidential-ledger.md) `azure-confidential-ledger` — azure
- [Double-entry ledger](https://localhost:3000/catalogue/components/double-entry-ledger.md) `double-entry-ledger` — default
- [Hyperledger Fabric](https://localhost:3000/catalogue/components/hyperledger-fabric.md) `hyperledger-fabric` — default
- [Generic ledger](https://localhost:3000/catalogue/components/ledger.md) `ledger` — default
- [TigerBeetle](https://localhost:3000/catalogue/components/tigerbeetle.md) `tigerbeetle` — default
- [Blockchain Node Engine](https://localhost:3000/catalogue/components/google-blockchain-node-engine.md) `google-blockchain-node-engine` — gcp
- [Oracle Blockchain Platform](https://localhost:3000/catalogue/components/oci-blockchain-platform.md) `oci-blockchain-platform` — oci

## Use it in a design

```yaml
nodes:
  - { id: "formance", component: "formance" }
```

## Source (`component` YAML, verbatim)

```yaml
# yaml-language-server: $schema=../../schema/component.schema.json
# Formance Ledger: programmable double-entry ledger with an immutable append-only transaction log,
# Numscript transactions and idempotency keys, stored in PostgreSQL ("Formance Ledger").
schemaVersion: "1"
type: "component"
id: "formance"
kind: "ledger"
provider: "default"
docs: "https://docs.formance.com/ledger/"
defaults:
  doubleEntry: true
  appendOnly: true
  indexConsistency: "strong"
  managed: false
properties:
  hosting:
    type: "enum"
    values: ["self-hosted", "formance-cloud"]
    default: "self-hosted"
  backingStore:
    type: "ref"
    refKind: "sql-database"
  idempotencyKeys:
    type: "boolean"
    default: true
```

Human page: https://localhost:3000/catalogue/components/formance