Overview

Event is a type of financial records representing follow-up actions that happen on other financial records, such as Line Item, Tax, etc. Common examples of Events:

• redemption of a gift card
• shipment of an e-commerce product
• delivery of a project milestone
• pause during subscription period

Create an Event

The following fields are required :

• objectType: type of financial record. For Event, the value is "event".
• id: unique identifier of this record. This is an external id received by Leapfin.
• amount: amount of money impacted by this Event. The value should be non-negative. This is the primary amount of this record.
• currencyCode: 3-digit ISO code of amount field, e.g. “USD”, "GBP", etc. This is the primary currency of this record
• date: the date-time of when this Event happened

The following fields are optional but are commonly needed for creating journal entries.

• description: description of the record. Use this field to explain what the Event represents.
• exchangeRates: a list of exchange rates used to calculate currency conversions
  • currencyCode: 3-digit ISO code, e.g. “USD”, "GBP", etc. This is the target currency of this record
  • rate: conversion rate from primary currency to target currency. i.e. amount in primary currency * rate = converted amount in target currency.
• links: directional relationships pointing from this record to other financial records. Event is commonly linked to Line Item.
  • objectType: type of the target financial record, e.g. "line-item"
  • id: unique identifier of the target financial record
• customFields: additional fields (i.e. key-value pairs) related to this record

Sample Data

{
    "objectType": "event",
    "id": "event_001",
    "amount": 15.32,
    "currencyCode": "USD",
    "date": "2021-03-03T12:09:52",
    "description": "a sample event object",
    "exchangeRates": [
      {
        "currencyCode": "EUR",
        "rate": 0.84
      },
      {
        "currencyCode": "GBP",
        "rate": 0.73
      }
    ],
    "links": [
      {
        "objectType": "line-item",
        "id": "lineitem_001"
      },
      {
        "objectType": "line-item",
        "id": "lineitem_002"
      }
    ],
    "customFields": {
      "field1": "value1",
      "field2": "value2"
    }
}

Query an Event

Event records are stored in VW_FT_RECOGNITION_EVENT table. It can be accessed via Snowflake Data Sharing and Access.