How do I configure a reconciliation definition?

  • Published on Jul 4, 2025
Prev Next

You can create a group reconciliation definition to configure a holding, transaction, and valuation reconciliation for a particular set of portfolios or groups.

Recommended reading: Understanding reconciliation definitions in LUSID

Methods

  1. Navigate to Reconciliations > Configuration, and select the Group reconciliations tab.

  2. Click the Create group reconciliation button and populate the form.

Call the CreateGroupReconciliationDefinition API, for example:

curl -X POST "https://<your-domain>.lusid.com/api/api/reconciliations/groupreconciliationdefinitions"
  -H "Authorization: Bearer <your-API-access-token>"
  -d "{
  "id": {
    "scope": "Finbourne-Examples",
    "code": "HoldingUnitsReconciliation"
  },
  "displayName": "Compare holding units",
  "description": "Compares holding units between two portfolios",
  "portfolioEntityIds": {
    "left": [
      {
        "scope": "Finbourne-Examples",
        "code": "EU",
        "portfolioEntityType": "SinglePortfolio"
      }
    ],
    "right": [
      {
        "scope": "Finbourne-Examples",
        "code": "EU-Custodian",
        "portfolioEntityType": "SinglePortfolio"
      }
    ]
  },
  "recipeIds": {
    "left": {
      "scope": "Finbourne-Examples",
      "code": "EU-Equities"
    },
    "right": {
      "scope": "Finbourne-Examples",
      "code": "EU-Equities"
    }
  },
  "currencies": {
    "left": "EUR",
    "right": "EUR"
  },
  "comparisonRulesetIds": {
    "holdingReconciliation": {
      "scope": "Finbourne-Examples",
      "code": "HoldingUnitsRule"
    }
  },
  "breakCodeSource": {
    "dataTypeId": {
      "scope": "reconciliations",
      "code": "break-codes"
    }
  }
}"

Fields

Portfolios

You must select one or more portfolios/groups for the left and right sides of the reconciliation. When the reconciliation runs, LUSID applies your selected rule for each reconciliation type to both sides.

Reconciliation types

You can select one reconciliation rule per reconciliation type. See how to create a reconciliation rule.

Parameters

Each reconciliation definition must specify the following for LUSID to use in evaluating the respective left or right portfolio/group:

  • Recipe left and Recipe right

  • Currency left and Currency right

For transaction reconciliations, you must also specify an amount of time for the Transaction date window.

Updating a group reconciliation definition

Once created, you can click the Edit icon to update a reconciliation definition.

When you update a group reconciliation definition:

  • All subsequent reconciliation runs that use the definition will use the updated version.

  • Reruns of an existing reconciliation instance that use the definition will use the updated version.