Skip to main content
Formance Ledger is a real-time money tracking microservice that lets you model and record complex financial transactions. It offers atomic, multi-posting transactions and is programmable using Numscript, a dedicated DSL (Domain Specific Language) to model and templatize such transactions.

​
Requirements

Formance Ledger requires:
  • PostgreSQL: See configuration guide here.
  • (Optional) Broker: See configuration guide here.

​
Ledger Object

You can find all the available parameters in the comprehensive CRD documentation.
apiVersion: formance.com/v1beta1
kind: Ledger
metadata:
  name: formance-dev
spec:
  stack: formance-dev

​
Settings (v2.4+)

​
Schema enforcement mode

Configure the schema enforcement mode for both the Ledger API and worker: 
apiVersion: formance.com/v1beta1
kind: Settings
metadata:
  name: ledger-schema-enforcement-mode
spec:
  stacks: ["*"]
  key: ledger.schema-enforcement-mode
  value: strict

​
Worker settings (v2.3+)

Starting with Ledger v2.3, a separate worker process is deployed alongside the main Ledger API. Configure the worker using the Settings CRD.

​
Async Block Hasher

Configure the async block hasher behavior: 
apiVersion: formance.com/v1beta1
kind: Settings
metadata:
  name: ledger-worker-async-block-hasher
spec:
  stacks: ["*"]
  key: ledger.worker.async-block-hasher
  value: max-block-size=500, schedule="0 */5 * * * *"
Available fields:
  • max-block-size: Maximum block size for the async block hasher
  • schedule: Cron schedule for the async block hasher

​
Bucket cleanup (v2.4+)

Configure the worker bucket cleanup behavior: 
apiVersion: formance.com/v1beta1
kind: Settings
metadata:
  name: ledger-worker-bucket-cleanup
spec:
  stacks: ["*"]
  key: ledger.worker.bucket-cleanup
  value: retention-period=720h, schedule="0 0 * * *"
Available fields:
  • retention-period: Retention period before bucket deletion
  • schedule: Cron schedule for the bucket cleanup job

​
Pipelines

Configure the worker pipelines behavior: 
apiVersion: formance.com/v1beta1
kind: Settings
metadata:
  name: ledger-worker-pipelines
spec:
  stacks: ["*"]
  key: ledger.worker.pipelines
  value: pull-interval=5s, push-retry-period=10s, sync-period=1m, logs-page-size=100
Available fields:
  • pull-interval: Interval between pipeline pulls
  • push-retry-period: Retry period for failed pushes
  • sync-period: Synchronization period
  • logs-page-size: Number of logs per page