How do I create a reconciliation rule?

  • Published on Jul 4, 2025
Prev Next

You can create a reconciliation rule to define the data to compare for a holding, transaction, or valuation reconciliation.

Recommended reading: Understanding reconciliation rules in LUSID

Methods

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

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

Call the CreateComparisonRuleset API, for example:

curl -X POST "https://<your-domain>.lusid.com/api/api/reconciliations/comparisonrulesets"
  -H "Authorization: Bearer <your-API-access-token>"
  -d "{
  "id": {
    "scope": "Finbourne-Examples",
    "code": "HoldingUnitsRule"
  },
  "displayName": "Compare holding units",
  "reconciliationType": "Holding",
  "coreAttributeRules": [
    {
      "left": {
        "key": "Instrument/default/Ticker",
        "operation": "Value"
      },
      "right": {
        "key": "Instrument/default/Ticker",
        "operation": "Value"
      },
      "allowableStringMappings": [
        {
          "leftValue": "MSFT",
          "rightValue": "MSF",
          "direction": "UniDirectional"
        }
      ],
      "isComparisonCaseSensitive": false
    },
    
  ],
  "aggregateAttributeRules": [
    {
      "left": {
        "key": "Holding/Units",
        "operation": "Value"
      },
      "right": {
        "key": "Holding/Units",
        "operation": "Value"
      },
    }
  ]
}"

Fields

Core attributes

Each rule must include one or more core attributes. The left and right core attributes define how to join the left and right sides of the reconciliation, ready for comparison.

Aggregate attributes

Each rule must include one or more aggregate attributes. The left and right core attributes define the values to compare and reconcile.

   

Updating a reconciliation rule

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

When you update a rule:

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

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