Overview

There are 4 types of entities that are combined to form a path to a unique dataset in PrecisionLender L3. They are the following:

The path to any dataset in PrecisionLender L3 can be constructed with this pattern:

  • /L3/v1.0/{Directory}/{Provider}/{Dataset Group}/{Dataset Name}/

For example, the path to the CoreAccountFinancialStatements dataset is:

  • /L3/v1.0/Primary/PL_RelationshipAwareness/Core/CoreAccountFinancialStatements/

 

Directory

  • Primary: Refers to raw datasets generated directly from the source provider.
  • Derived: Refers to transformed datasets generated from one or more raw datasets sourced from one or more providers.

 

Provider

Refers to the source provider of the data.

  • PL_Andi: Refers to raw datasets sourced from Andi in the PrecisionLender Application.
  • PL_Application: Refers to raw datasets sourced from the PrecisionLender Application.
  • PL_RelationshipAwareness: Refers to raw datasets sourced from Relationship Awareness (RA).

 

Dataset Group

Each Dataset Group represents a set of datasets related to a common, shared entity. Select a dataset group below to view its respective datasets and providers.

 

Dataset Name

Refers to the name of the dataset.

_______________________________________________________________________

 

Assumptions

This group contains datasets related to the assumptions used for calculation of financial statements.

Provider: PL_RelationshipAwareness  

AssumptionSets

Description

This dataset contains the assumptions used for calculations in a given run of Relationship Awareness (RA).

Data Type

  • JSON

Path

/L3/v1.0/Primary/PL_RelationshipAwareness/Assumptions/AssumptionSets/

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • AssumptionSetId
CommercialLoanProducts

Description

The dataset contains the commercial loan product assumptions used for a given run of Relationship Awareness (RA).

Path

/L3/v1.0/Primary/PL_RelationshipAwareness/Assumptions/...
...CommercialLoanProducts/ 

Data Type

  • JSON

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • ProductAssumptionSetId
  • ProductId
ConsumerLoanProducts

Description

The dataset contains the consumer loan product assumptions used for a given run of Relationship Awareness (RA).

Path

/L3/v1.0/Primary/PL_RelationshipAwareness/Assumptions/…
…ConsumerLoanProducts/

Data Type

  • JSON

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • ProductAssumptionSetId
  • ProductId
DepositProducts

Description

The dataset contains the deposit product assumptions used for a given run of Relationship Awareness (RA).

Path

/L3/v1.0/Primary/PL_RelationshipAwareness/Assumptions/DepositProducts/

Data Type

  • JSON

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • ProductAssumptionSetId
  • ProductId
OtherProducts

Description

The dataset contains the other product assumptions used for a given run of Relationship Awareness (RA).

Path

/L3/v1.0/Primary/PL_RelationshipAwareness/Assumptions/OtherProducts/

Data Type

  • JSON

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • ProductAssumptionSetId
  • ProductId

 

Provider: PL_Application

AssumptionSets

Description

This dataset contains the assumptions used for pricing opportunities in the PrecisionLender Application for a given date.

Path

/L3/v1.0/Primary/PL_Application/Assumptions/AssumptionSets/

Data Type

  • JSON

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • AssumptionSetId
CommercialLoanProducts

The dataset contains the commercial loan product assumptions configured in the PrecisionLender application for a given date.

Path

/L3/v1.0/Primary/PL_Application/Assumptions/CommercialLoanProducts/

Data Type

  • JSON

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • ProductAssumptionSetId
  • ProductId
ConsumerLoanProducts

Description

The dataset contains the consumer loan product assumptions configured in the PrecisionLender application for a given date.

Path

/L3/v1.0/Primary/PL_Application/Assumptions/ConsumerLoanProducts/

Data Type

  • JSON

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • ProductAssumptionSetId
  • ProductId
DepositProducts

Description

The dataset contains the deposit product assumptions configured in the PrecisionLender application for a given date.

Path

/L3/v1.0/Primary/PL_Application/Assumptions/DepositProducts/

Data Type

  • JSON

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • ProductAssumptionSetId
  • ProductId
OtherProducts

Description

The dataset contains the other product assumptions configured in the PrecisionLender application for a given date.

Path

/L3/v1.0/Primary/PL_Application/Assumptions/OtherProducts/

Data Type

  • JSON

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • ProductAssumptionSetId
  • ProductId

 Back to Top

 

Conversations

This group contains datasets related to Andi events occurring during opportunity pricing. An Andi event may be one of: Application Event, Chat Event. An application event is a notification sent to Andi related to the opportunity context (Ex: Changing the deal amount). A chat event is a notification to Andi that the user has submitted text into the Andi window.

Provider: PL_Andi

Conversations

Description

This dataset contains a detailed record for every event in every conversation in the context of a given opportunity.

Path

/L3/v1.0/Primary/PL_Andi/Conversations/Conversations/

Data Type

  • JSON

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • conversationId
  • SkillActivities.event.id
  • SkillActivities.id

 Back to Top

 

Core

This group contains datasets related to the accounts from your bank's core system.

Provider: PL_RelationshipAwareness

CoreDepositAccounts

Description

This dataset contains all core deposit accounts that were active for a given run of Relationship Awareness (RA). 

Path

/L3/v1.0/Primary/PL_RelationshipAwareness/Core/CoreDepositAccounts/

Data Type

  • CSV

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • Id
  • RaRunId
CoreAccountFinancialStatements

Description

This dataset contains all financial statements for all core accounts that were active for a given run of Relationship Awareness (RA).

Path

/L3/v1.0/Primary/PL_RelationshipAwareness/Core/…
…CoreAccountFinancialStatements/

Data Type

  • CSV

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • Id
  • RaRunId
  • CoreAccountId
  • FinancialStatementTypeEnum
CoreCommercialLoanAccounts

Description

This dataset contains all core commercial loan accounts that were active for a given run of Relationship Awareness (RA).

Path

/L3/v1.0/Primary/PL_RelationshipAwareness/Core/…
…CoreCommercialLoanAccounts/

Data Type

  • CSV

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • Id
  • RaRunId
  • CoreAccountId 
CoreCollateralPositions

Description

This dataset contains all unique pieces of core collateral, along with their respective descriptions, linked with core commercial loan accounts that were active for a given run of Relationship Awareness (RA).

Path

/L3/v1.0/Primary/PL_RelationshipAwareness/Core/CoreCollateralPositions/

Data Type

  • CSV

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • Id
  • RaRunId
CoreOtherAccounts

Description

This dataset contains all core other accounts that were active for a given run of Relationship Awareness (RA).

Path

/L3/v1.0/Primary/PL_RelationshipAwareness/Core/CoreOtherAccounts/

Data Type

  • CSV

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • Id
  • RaRunId
CoreAccountDetails

Description

This dataset contains details associated with every core account over time. Each core account is associated with both FTP and strategic financial statements for every valid run of Relationship Awareness (RA).

Path

/L3/v1.0/Derived/PL_RelationshipAwareness/Core/CoreAccountDetails/

Data Type

  • CSV

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • RaRunId
  • CoreAccountId
  • FinancialStatementTypeEnum

Schema

Field Name Data Type Description
RaRunId GUID The unique identifier for the Relationship Awareness (RA) run.
CoreAccountId GUID The unique PrecisionLender identifier for the account.
ExternalIdentifier string The hashed representation of the unique record identifier provided in RA data files.
AccountType string The type of account.
FinancialStatementTypeEnum int The enumerator for the financial statement used in calculations.
FinancialStatementType string The type of financial statement corresponding with the enumerator used in calculations.
ProductFamilyId GUID The unique identifier for the family of the product associated with the account.
ProductName string The name of the product associated with the account.
PaymentTypeEnum int The enumerator for the payment type associated with a loan account.
PaymentType string The payment type corresponding with the enumerator associated with a loan account.
RateTypeEnum int The enumerator for the rate type associated with a loan account.
RateType string The rate type corresponding with the enumerator associated with a loan account.
RiskRatingId GUID The unique identifier of the risk rating for a loan account.
RiskRating string The risk rating for a loan account.
NaicsCode string The industry classification of the borrower associated with the account.
PostalCode string The zip code of the borrower associated with the account.
CountryCode string The code indicating the country of account origination.
Percentile long The percentile of the relationship based on the strategic profitability within the bank.
OwnerPercentile long The percentile of the relationship based on the strategic profitability within the banker's portfolio.
RegionalPercentile long The percentile of the relationship based on the strategic profitability within the banker's home region.
OwnerId GUID The owner of the account.
TopLevelParent GUID The highest level relationship identifier for the account.
RelationshipId GUID The unique identifier for the relationship associated with the account.
RelationshipExternalIdentifier string The hashed representation of the unique record relationship identifier provided in RA data files.
CoreRelationshipName string The name of the relationship associated with the account.
InterestIncome double The effective interest income for a deposit or loan account.
InterestExpense double The effective interest expense for a deposit or loan account.
NetInterestIncome double The effective net interest income for a deposit or loan account.
NonInterestExpense double The effective non-interest expense or, if negative, the non-interest income for a deposit or loan account.
LoanLossReserve double The annualized expected loss for a loan account.
OtherIncome double The income generated from other fee-based accounts.
PreTaxIncome double The pretax income for the account.
Taxes double The effective tax amount for the account.
NetIncome double The net income for the account.
AverageAssets double The effective average annualized assets.
AverageEquity double The effective average annualized equity (allocated capital).
AverageLiabilities double The effective average annualized liabilities.
ROE double The return on equity of the account.
ROA double The return on assets of the account.
TargetROE double The target return on equity for the account.
CapFloorImpact double The impact of a cap and floor on the loan account.
LoanAmount double The balance of a loan account at origination.
LoanBalance double The average loan balance calculated over the specified horizon. For most accounts, the specified horizon is the lifetime of the loan account.
LoanCommitment double The commitment of a loan account.
LoanNetFunding double The loan gross funding less any paid-off balances.
DepositAverageBalance double The average balance of a deposit account.
LoanNetCommitment double The total commitment of a loan, minus any previous commitments made to this relationship that are being paid off with a new loan (if present).
OtherEarningsCreditEligibleRevenue double The revenueseligible for earnings credit from a other fee-based accounts.
OtherEarningsCreditIneligibleRevenue double The revenues ineligible for earnings credit from other fee-based accounts.
OtherGrossRevenue double The revenues generated by an other account, net of any servicing costs.
OtherAccountRevenueEarningsCreditGenerated double The total amount from earnings credit generated by an other fee-based account.
OtherAppliedEarningsCredit double The amount applied to a deposit account to offset activity-based charges.
OtherNetRevenue double The revenues generated by an other account, net of any applied earnings credits.
OtherServicingExpense double The additional servicing expenses associated with a loan account.
AverageRegulatoryCapital double The average regulatory capital held for a loan account.
AverageEconomicCapital double The average economic capital held for a loan account.
RORC double The return on regulatory capital.
ROEC double The return on economic capital.
AverageMaximumOfRegulatoryAndEconomic double The average maximum of the regulatory and economic capital held for a loan account.
ROMCE double The return on the average maximum of regulatory and economic capital.
EarningsOnCapital double The earnings on the capital held for a loan account.
Revenue double The reported revenue for the account.
ActualLife int The projected actual life of a loan account based on the term of the loan adjusted for any prepayments.
TopLevelParent_ROA double The ROA for the TopLevelParent of the relationship associated with the account.
TopLevelParent_ROE double The ROE for the TopLevelParent of the relationship associated with the account.

 Back to Top

 

Engagement

This group contains datasets related to user engagements with Andi. An engagement is a message sent to users as the result of an Andi skill run.

Provider: PL_Andi

EngagementEvents

Description

This dataset contains a unique record for every engagement event on the Opportunity Screen. An engagement event is a notification message sent to Andi related to an engagement, for example when an engagement is viewed or acted upon.

Path

/L3/v1.0/Primary/PL_Andi/Engagement/EngagementEvents/

Data Type

  • AVRO

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • clientTimestamp
  • skillActivityId
FieldTagEngagements

Description

This dataset contains a record for every Andi field tag engagement on the Opportunity Screen. An engagement is a message sent to users as the result of a skill run.

Path

/L3/v1.0/Primary/PL_Andi/Engagement/FieldTagEngagements/

Data Type

  • AVRO

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • Id
PLChatEngagements

Description

This dataset contains a record for every Andi Chat engagement on the Opportunity Screen. An engagement is a message sent to users as the result of a skill run.

Path

/L3/v1.0/Primary/PL_Andi/Engagement/PLChatEngagements/

Data Type

  • AVRO

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • Id

Back to Top

 

Opportunities

This group contains datasets related to opportunities priced in the PrecisionLender application.

Provider: PL_Application

Opportunities

Description

This dataset contains a record with details for every opportunity snapshot; there is a record for every save of an opportunity in the PrecisionLender application.

Path

/L3/v1.0/Primary/PL_Application/Opportunities/Opportunities/

Data Type

  • JSON

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • Id
  • OpportunityId
  • LastModified
OpportunityOverrides

Description

This dataset contains records for overrides in the context of opportunities. In this dataset, overrides apply to the RiskRating and RiskRatingScorecard fields for a given opportunity.

Path

/L3/v1.0/Primary/PL_Application/Opportunities/OpportunityOverrides/

Data Type

  • CSV

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • OverrideOpportunityId
  • RelationshipNewId
  • OverrideCreated
  • OverrideFieldName
OpportunityStages

Description

This dataset contains a record for every unique opportunity stage configured in the PrecisionLender Application for a given date.

Path

/L3/v1.0/Primary/PL_Application/Opportunities/OpportunityStages/

Data Type

  • CSV

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • OpportunityStageId

 Back to Top

 

Regions

This group contains datasets related to the regions configured by your bank.

Provider: PL_RelationshipAwareness

RegionsHierarchy

Description

This dataset contains the nested JSON of the reporting regions used for a given run of Relationship Awareness (RA).

Path

/L3/v1.0/Primary/PL_RelationshipAwareness/Regions/RegionsHierarchy/

Data Type

  • JSON

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • Id
RegionsFlat

Description

This dataset contains the flat CSV of the reporting regions used for a given run of Relationship Awareness (RA). Each record in the dataset represents a unique region along with its associated parent region.

Path

/L3/v1.0/Primary/PL_RelationshipAwareness/Regions/RegionsFlat/

Data Type

  • CSV

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • Id

 

Provider: PL_Application

Regions

Description

This dataset contains the flat CSV of the reporting regions configured in the PrecisionLender Application for a given date. Each record in the dataset represents a unique region along with its associated parent region.

Path

/L3/v1.0/Primary/PL_Application/Regions/Regions/

Data Type

  • CSV

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • Id
RegionsHierarchy

Description

This dataset contains the nested JSON of the reporting regions configured in the PrecisionLender Application for a given date.

Path

/L3/v1.0/Primary/PL_Application/Regions/RegionsHierarchy/

Data Type

  • JSON

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • Id
RegionsHierarchyFlattened

Description

This dataset contains the configured regions as well as all of their associated parent regions (region levels). For example, the region, New York, would be at the third level of the region hierarchy below: 

  • United States
    • West
    • Midwest
    • Southwest
    • Southeast
    • Northeast
      • New York
      • Pennsylvania .

There are 3 region levels associated with the New York region: United States (level 1), Northeast (level 2), and New York (level 3)

 

Path

/L3/v1.0/Derived/PL_Application/Regions/RegionsHierarchyFlattened/

Data Type

  • CSV

 

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • RegionId

Schema

Field Name Data Type Description
RegionId GUID The unique identifier for the region.
Region string The name of the region.
RegionLevel(0-N) string There is a field for every level of the region hierarchy to which the region belongs.
RegionIdLevel(0-N) GUID There is a corresponding unique identifier for every level of the region hierarchy to which the region belongs.

Back to Top

 

Relationships

The group contains datasets related to the relationships from your bank's core system.

Provider: PL_RelationshipAwareness

RelationshipsLegacy

Description

This dataset contains all relationships that were active for a given run of Relationship Awareness (RA). Every record in the dataset represents a single, unique relationship.

Path

/L3/v1.0/Primary/PL_RelationshipAwareness/Relationships/…
…RelationshipsLegacy/

Data Type

  • CSV

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • Id
  • RaRunId
RelationshipIdentifierLegacy

Description

This dataset contains all child relationships linked to a single parent relationship that were active for a given run of Relationship Awareness (RA). Every record in the dataset represents a unique child relationship and its linked parent relationship.

Path

/L3/v1.0/Primary/PL_RelationshipAwareness/Relationships/…
…RelationshipIdentifierLegacy/

Data Type

  • CSV

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • Id
  • RaRunId
  • RelationshipId
RelationshipFinancialStatements

Description

This dataset contains all financial statements for relationships that were active for a given run of Relationship Awareness (RA).

Path

/L3/v1.0/Primary/PL_RelationshipAwareness/Relationships/…
…RelationshipFinancialStatements/

Data Type

  • CSV

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • Id
  • RaRunId
  • RelationshipId
  • RelationshipSubTotalTypeEnum

 

Provider: PL_Application

RelationshipOverrides

Description

This dataset contains records for overrides on core loan accounts in the context of a given relationship. In this dataset, overrides apply to the rate and maturityDate fields of a core loan account.

Path

/L3/v1.0/Primary/PL_Application/Relationships/RelationshipOverrides/

Data Type

  • CSV

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • OverrideCoreAccountId
  • OverrideFieldName
  • OverrideCreated

Back to Top

 

Telemetry

This group contains datasets related to user interactions with Andi skills during opportunity pricing.

Provider: PL_Andi

Impressions

Description

This dataset contains a record for every impression (view) of an Andi Skill on the Opportunity Screen.

Path

/L3/v1.0/Primary/PL_Andi/Telemetry/Impressions/

Data Type

  • JSON

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • skillActivityId
  • time
Actions

Description

This dataset contains a record for every action (click) of an Andi Skill on the Opportunity Screen.

Path

/L3/v1.0/Primary/PL_Andi/Telemetry/Actions/

Data Type

  • JSON

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • skillActivityId
  • time 

Back to Top

 

Users

This group contains datasets related to the users of the PrecisionLender application at your bank.

Provider: PL_Application

SecurityProfiles

Description

This dataset contains a detailed record for every security profile, region combination for a given date.

Path

/L3/v1.0/Primary/PL_Application/Users/SecurityProfiles/

Data Type

  • CSV

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • SecurityProfileId
  • RegionsId
UserLogins

Description

This dataset contains a record of every unique login to the PrecisionLender Application.

Path

/L3/v1.0/Primary/PL_Application/Users/UserLogins/

Data Type

  • CSV

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • LoginId
Users

Description

This dataset contains a record for every unique user configured in the the PrecisionLender Application along with their associated details including each user's security profile rights for a given date.

Path

/L3/v1.0/Primary/PL_Application/Users/Users/

Data Type

  • CSV

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • UserId

Back to Top

 

Validation

This group contains datasets related to the validation of your bank's data.

Provider: PL_RelationshipAwareness

RunStatusesLegacy

Description

This dataset contains the nested JSON of the reporting regions configured in the PrecisionLender Application for a given date.

Path

/L3/v1.0/Primary/PL_RelationshipAwareness/Validation/RunStatusesLegacy/

Data Type

  • JSON

Primary Key

A unique record for the dataset can be generated with the following combination of fields:

  • Id

Back to Top