How do I add a general ledger profile with mappings to a chart of accounts?

You can add one or more general ledger profiles, each containing any number of mappings, to an existing chart of accounts (CoA).

Note the order in which mappings are specified in a profile is significant. For each journal entry line, LUSID uses the first matching mapping found to assign journal entry lines to levels in order to break down account activity in a trial balance.

Methods

curl -X POST 'https://<your-domain>.lusid.com/api/api/chartofaccounts/CoAs/DailyCoA/generalledgerprofile'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "generalLedgerProfileCode": "STEM",
  "displayName": "STEM",
  "description": "STEM profile",
  "generalLedgerProfileMappings": [
    {
      "mappingFilter": "GeneralLedgerAccountCode eq '1-Investments'",
      "levels": [
        "DefaultCurrency"
      ]
    },
    {
      "mappingFilter": "EconomicBucket startswith 'PL_' and Properties[Instrument/default/LusidInstrumentId] startswith 'CCY_'",
      "levels": [
        "SourceType", "EconomicBucket", "ActivityDate"
      ]
    },
    {
      "mappingFilter": "True",
      "levels": [
        "Instrument.AssetClass"
      ]
    }
  ]
}'

Data fields

This section supplements the API documentation and on-screen help text in the LUSID web app.

A profile is identified by a code that must be unique within the parent CoA.

You can specify any number of generalLedgerProfileMappings that match journal entry lines to levels (that is, categories to divide accounts into). Note the order is significant. Each mapping consists of:

• A mappingFilter expression that describes criteria for matching journal entry lines.

• Up to five levels to apply to journal entry lines matching those criteria, specified as an ordered list of strings. Syntax and allowed values.

Subsequent updates

Once a profile is created, you cannot change the code, displayName or description.

You can specify a new ordered set of mappings using the SetGeneralLedgerProfileMappings API; note the new set replaces the existing set, so include any mappings you want to retain in the request.

You can change the order of mappings in the LUSID web app using the grab handles (in red). You cannot currently patch a profile using the LUSID API.

To delete a profile, call the DeleteGeneralLedgerProfile API.

Syntax of a general ledger profile mapping

Each general ledger profile mapping consists of:

• A mappingFilter expression that describes criteria for matching journal entry lines. See below.

• Up to five levels to apply to journal entry lines matching those criteria, specified as an ordered list. More information.

Mapping filter expressions

The syntax of a mappingFilter expression is:

<attribute> <operator> <value>

...where:

• <attribute> is a field, property or other data item to test against. Allowed values are GeneralLedgerAccountCode and all the attributes in this table.

• <operator> is one of the LUSID filter operators.

• <value> is a value appropriate to the data type of <attribute>.

Note the following:

• A mappingFilter expression is case-insensitive.

• A string <value> must be enclosed in single straight quote marks (the %27 UTF-8 encoding).

• You can concatenate expressions using the and and or operators, for example:
  GeneralLedgerAccountCode eq '1-Investments' and subholdingkeys[Transaction/Ibor/Strategy] eq 'Income'

  
  If you use both, standard boolean operator precedence applies:
  EconomicBucket startswith 'NA' or (DefaultCurrency in 'GBP', 'USD' and HoldType eq 'P')

Levels

You can specify up to five levels as an ordered, comma-separated list of strings. In the following example, Instrument.AssetClass is the first (or most significant) level, and Account.type the last (or least):

["Instrument.assetClass", "Properties[Portfolio/Ibor/Region]", "DefaultCurrency", "EconomicBucket", "Account.type"]