@mx-cartographer/experiences 4.0.13 → 4.0.14-alpha.JB1

package/src/common/types/Account.ts

@@ -0,0 +1,406 @@
+export interface Account {
+  account_number?: string
+  account_subtype?: AccountSubType
+  account_type: AccountType
+  apr?: number
+  apy?: number
+  available_balance?: number
+  balance?: number
+  balance_updated_at?: number
+  cash_balance?: number
+  credit_limit?: number
+  current_balance?: number
+  currency_code?: string
+  day_payment_is_due?: number
+  display_order?: number
+  external_guid?: string
+  feed_account_type?: number
+  feed_apr?: number
+  feed_apy?: number
+  feed_credit_limit?: number
+  feed_day_payment_is_due?: number
+  feed_interest_rate?: number
+  feed_is_closed?: boolean
+  feed_localized_name?: string
+  feed_name?: string
+  feed_nickname?: string
+  feed_original_balance?: number
+  flags?: number
+  guid: string
+  institution_guid?: string
+  interest_rate?: number
+  interest_rate_set_by?: number
+  interestRate?: number
+  is_closed: boolean
+  is_deleted: boolean
+  is_excluded_from_accounts: boolean
+  is_excluded_from_budgets: boolean
+  is_excluded_from_cash_flow: boolean
+  is_excluded_from_debts: boolean
+  is_excluded_from_goals: boolean
+  is_excluded_from_investments: boolean
+  is_excluded_from_net_worth: boolean
+  is_excluded_from_spending: boolean
+  is_excluded_from_transactions: boolean
+  is_excluded_from_trends: boolean
+  is_hidden: boolean
+  is_manual: boolean
+  is_personal: boolean
+  localized_name?: string
+  member_guid?: string
+  member_is_managed_by_user: boolean
+  metadata?: string
+  minimum_payment?: number
+  name?: string
+  nickname?: string
+  original_balance?: number
+  payment_due_at?: number
+  pending_balance?: number
+  property_type?: PropertyType
+  revision?: number
+  updated_at?: number
+  user_guid?: string
+  user_name?: string
+
+  // UI Added fields
+  memberName?: string
+  connectionStatus?: ConnectionStatus
+
+  // UI Added fields from Pulse
+  displayName?: string
+  truncatedDisplayName?: string
+  institutionName?: string
+}
+
+export interface DetailedAccount extends Account {
+  institution_name: string
+  isEnabled: boolean
+  name: string
+}
+
+export interface Member {
+  aggregation_status: number
+  connection_status: number
+  guid: string
+  institution_guid: string
+  institution_name?: string
+  institution_url?: string
+  is_being_aggregated: boolean
+  is_manual: boolean
+  is_managed_by_user: boolean
+  is_oauth: boolean
+  last_job_guid?: string
+  last_job_status?: string
+  last_update_time?: number
+  metadata?: string
+  mfa: any
+  most_recent_job_guid?: string
+  needs_updated_credentials: boolean
+  name: string
+  process_status?: number
+  revision: number
+  user_guid: string
+  oauth_window_uri?: string
+  verification_is_enabled: boolean
+  tax_statement_is_enabled: boolean
+  successfully_aggregated_at?: number
+
+  // UI Added fields
+  connectionStatus?: ConnectionStatus
+}
+
+export interface MonthlyAccountBalance {
+  account_guid: string
+  balance: number
+  credit_transaction_total: number
+  debit_transaction_total: number
+  id: string
+  month: number
+  transaction_total: number
+  user_guid: string
+  year: number
+  year_month: number
+}
+
+export enum AccountType {
+  ANY = 0,
+  CHECKING = 1,
+  SAVINGS = 2,
+  LOAN = 3,
+  CREDIT_CARD = 4,
+  INVESTMENT = 5,
+  LINE_OF_CREDIT = 6,
+  MORTGAGE = 7,
+  PROPERTY = 8,
+  CASH = 9,
+  INSURANCE = 10,
+  PREPAID = 11,
+  CHECKING_LINE_OF_CREDIT = 12,
+  DIGITAL_WALLET = 13,
+}
+
+export enum AccountSubType {
+  NONE = 0,
+  MONEY_MARKET = 1,
+  CERTIFICATE_OF_DEPOSIT = 2,
+  AUTO = 3,
+  STUDENT = 4,
+  SMALL_BUSINESS = 5,
+  PERSONAL = 6,
+  PERSONAL_WITH_COLLATERAL = 7,
+  HOME_EQUITY = 8,
+  PLAN_401_K = 9,
+  PLAN_403_B = 10,
+  PLAN_529 = 11,
+  IRA = 12,
+  ROLLOVER_IRA = 13,
+  ROTH_IRA = 14,
+  TAXABLE = 15,
+  NON_TAXABLE = 16,
+  BROKERAGE = 17,
+  TRUST = 18,
+  UNIFORM_GIFTS_TO_MINORS_ACT = 19,
+  PLAN_457 = 20,
+  PENSION = 21,
+  EMPLOYEE_STOCK_OWNERSHIP_PLAN = 22,
+  SIMPLIFIED_EMPLOYEE_PENSION = 23,
+  SIMPLE_IRA = 24,
+  BOAT = 25,
+  POWERSPORTS = 26,
+  RV = 27,
+  HELOC = 28,
+  PLAN_ROTH_401_K = 29,
+  FIXED_ANNUITY = 30,
+  VARIABLE_ANNUITY = 31,
+  VEHICLE_INSURANCE = 32,
+  DISABILITY = 33,
+  HEALTH = 34,
+  LONG_TERM_CARE = 35,
+  PROPERTY_AND_CASUALTY = 36,
+  UNIVERSAL_LIFE = 37,
+  TERM_LIFE = 38,
+  WHOLE_LIFE = 39,
+  ACCIDENTAL_DEATH_AND_DISMEMBERMENT = 40,
+  VARIABLE_UNIVERSAL_LIFE = 41,
+  HSA = 42,
+  TAX_FREE_SAVINGS_ACCOUNT = 43,
+  INDIVIDUAL = 44,
+  REGISTERED_RETIREMENT_INCOME_FUND = 45,
+  CASH_MANAGEMENT_ACCOUNT = 46,
+  EMPLOYEE_STOCK_PURCHASE_PLAN = 47,
+  REGISTERED_EDUCATION_SAVINGS_PLAN = 48,
+  PROFIT_SHARING_PLAN = 49,
+  UNIFORM_TRANSFER_TO_MINORS_ACT = 50,
+  PLAN_401_A = 51,
+  SARSEP_IRA = 52,
+  FIXED_ANNUITY_TRADITIONAL_IRA = 53,
+  VARIABLE_ANNUITY_TRADITIONAL_IRA = 54,
+  SEPP_IRA = 55,
+  INHERITED_TRADITIONAL_IRA = 56,
+  FIXED_ANNUITY_ROTH_IRA = 57,
+  VARIABLE_ANNUITY_ROTH_IRA = 58,
+  INHERITED_ROTH_IRA = 59,
+  COVERDELL = 60,
+  ADVISORY_ACCOUNT = 61,
+  BROKERAGE_MARGIN = 62,
+  CHARITABLE_GIFT_ACCOUNT = 63,
+  CHURCH_ACCOUNT = 64,
+  CONSERVATORSHIP = 65,
+  CUSTODIAL = 66,
+  DEFINED_BENEFIT_PLAN = 67,
+  DEFINED_CONTRIBUTION_PLAN = 68,
+  EDUCATIONAL = 69,
+  ESTATE = 70,
+  EXECUTOR = 71,
+  GROUP_RETIREMENT_SAVINGS_PLAN = 72,
+  GUARANTEED_INVESTMENT_CERTIFICATE = 73,
+  HRA = 74,
+  INDEXED_ANNUITY = 75,
+  INVESTMENT_CLUB = 76,
+  IRREVOCABLE_TRUST = 77,
+  JOINT_TENANTS_BY_ENTIRITY = 78,
+  JOINT_TENANTS_COMMUNITY_PROPERTY = 79,
+  JOINT_TENANTS_IN_COMMON = 80,
+  JOINT_TENANTS_WITH_RIGHTS_OF_SURVIVORSHIP = 81,
+  KEOUGH_PLAN = 82,
+  LIFE_INCOME_FUND = 83,
+  LIVING_TRUST = 84,
+  LOCKED_IN_RETIREMENT_ACCOUNT = 85,
+  LOCKED_IN_RETIREMENT_INVESTMENT_FUND = 86,
+  LOCKED_IN_RETIREMENT_SAVINGS_ACCOUNT = 87,
+  MONEY_PURCHASE_PLAN = 88,
+  PARTNERSHIP = 89,
+  PLAN_409_A = 90,
+  PLAN_ROTH_403_B = 91,
+  REGISTERED_DISABILITY_SAVINGS_PLAN = 92,
+  REGISTERED_LOCKED_IN_SAVINGS_PLAN = 93,
+  REGISTERED_PENSION_PLAN = 94,
+  REGISTERED_RETIREMENT_SAVINGS_PLAN = 95,
+  REVOCABLE_TRUST = 96,
+  ROTH_CONVERSION = 97,
+  SOLE_PROPRIETORSHIP = 98,
+  SPOUSAL_IRA = 99,
+  SPOUSAL_ROTH_IRA = 100,
+  TESTAMENTARY_TRUST = 101,
+  THRIFT_SAVINGS_PLAN = 102,
+  INHERITED_ANNUITY = 103,
+  CORPORATE_ACCOUNT = 104,
+  LIMITED_LIABILITY_ACCOUNT = 105,
+  HSA_SAVINGS = 106,
+  HSA_CHECKING = 107,
+}
+
+export enum PropertyType {
+  REAL_ESTATE = 0,
+  VEHICLE = 1,
+  ART = 2,
+  JEWELRY = 3,
+  FURNITURE = 4,
+  APPLIANCES = 5,
+  COMPUTER = 6,
+  ELECTRONICS = 7,
+  SPORTS_EQUIPMENT = 8,
+  MISCELLANEOUS = 9,
+}
+
+export enum ConnectionStatusEnums {
+  CREATED = 0, // The member is new and has not aggregated yet
+  PREVENTED = 1, // MX preventing aggregation until credentials are updated
+  DENIED = 2, // Invalid credentials
+  CHALLENGED = 3, // MFA presented
+  REJECTED = 4, // MFA answered incorrectly
+  LOCKED = 5, // Institution is preventing authentication, user must contact FI
+  CONNECTED = 6, // Successfully authenticated and aggregating data
+  IMPEDED = 7, // User attention is needed in online banking (marketing message, terms and conditions etc.)
+  RECONNECTED = 8, // The connection has been migrated, we will not aggregate until user interacts with UI
+  DEGRADED = 9, // Aggregation has failed for a short period with a minimum number of attempts
+  DISCONNECTED = 10, // Aggregation has failed for an extended period of time with a minimum number of attempts
+  DISCONTINUED = 11, // The connection to this institution is no longer available
+  CLOSED = 12, // The user, MX, the client or partner have marked the account as closed
+  DELAYED = 13, // Aggregation has taken longer than expected without being CONNECTED
+  FAILED = 14, // Aggregation failed without being CONNECTED
+  UPDATED = 15, // Credenitals have been updated, but the member has not yet been CONNECTED
+  DISABLED = 16, // Aggregation has been momentarily paused, but the member is still CONNECTED
+  IMPORTED = 17, // Member was imported from another provider using the MDX Migration API
+  RESUMED = 18, // MFA has been answered and has not yet been CONNECTED
+  EXPIRED = 19, // MFA has not been answered before job timed out
+  IMPAIRED = 20, // Memeber is missing some or all credentials needed to connect
+  PENDING = 21, // OAuth member created but waiting for authentication redirect // Not visible to user
+}
+
+export const ProcessingStatuses = [
+  ConnectionStatusEnums.CREATED,
+  ConnectionStatusEnums.UPDATED,
+  ConnectionStatusEnums.RESUMED,
+]
+
+export const MfaStatuses = [ConnectionStatusEnums.CHALLENGED, ConnectionStatusEnums.REJECTED]
+
+export const ErrorStatuses = [
+  ConnectionStatusEnums.PREVENTED,
+  ConnectionStatusEnums.DENIED,
+  ConnectionStatusEnums.LOCKED,
+  ConnectionStatusEnums.IMPEDED,
+  ConnectionStatusEnums.DEGRADED,
+  ConnectionStatusEnums.DISCONNECTED,
+  ConnectionStatusEnums.DISCONTINUED,
+  ConnectionStatusEnums.CLOSED,
+  ConnectionStatusEnums.DELAYED,
+  ConnectionStatusEnums.FAILED,
+  ConnectionStatusEnums.DISABLED,
+  ConnectionStatusEnums.IMPORTED,
+  ConnectionStatusEnums.EXPIRED,
+  ConnectionStatusEnums.IMPAIRED,
+]
+
+export const NonConnectedStatuses = [...ErrorStatuses, ...MfaStatuses]
+
+export enum ConnectionStatus {
+  Connected = 'Connected',
+  Error = 'Error',
+  Processing = 'Processing',
+  RequiresMfa = 'RequiresMfa',
+}
+
+export const StatusName: any = {
+  [ConnectionStatusEnums.CHALLENGED]: 'Challenged',
+  [ConnectionStatusEnums.CLOSED]: 'Closed',
+  [ConnectionStatusEnums.DEGRADED]: 'Degraded',
+  [ConnectionStatusEnums.DELAYED]: 'Delayed',
+  [ConnectionStatusEnums.DENIED]: 'Denied',
+  [ConnectionStatusEnums.DISABLED]: 'Disabled',
+  [ConnectionStatusEnums.DISCONNECTED]: 'Disconnected',
+  [ConnectionStatusEnums.DISCONTINUED]: 'Discontinued',
+  [ConnectionStatusEnums.EXPIRED]: 'Expired',
+  [ConnectionStatusEnums.FAILED]: 'Failed',
+  [ConnectionStatusEnums.IMPAIRED]: 'Impaired',
+  [ConnectionStatusEnums.IMPEDED]: 'Impeded',
+  [ConnectionStatusEnums.IMPORTED]: 'Imported',
+  [ConnectionStatusEnums.LOCKED]: 'Locked',
+  [ConnectionStatusEnums.PREVENTED]: 'Prevented',
+  [ConnectionStatusEnums.REJECTED]: 'Rejected',
+}
+
+export const AccountTypeName: any = {
+  [AccountType.ANY]: 'Any',
+  [AccountType.CASH]: 'Cash',
+  [AccountType.CHECKING]: 'Checking',
+  [AccountType.CHECKING_LINE_OF_CREDIT]: 'Checking Line of Credit',
+  [AccountType.CREDIT_CARD]: 'Credit Card',
+  [AccountType.DIGITAL_WALLET]: 'Digital Wallet',
+  [AccountType.INSURANCE]: 'Insurance',
+  [AccountType.INVESTMENT]: 'Investment',
+  [AccountType.LINE_OF_CREDIT]: 'Line of Credit',
+  [AccountType.LOAN]: 'Loan',
+  [AccountType.MORTGAGE]: 'Mortgage',
+  [AccountType.PREPAID]: 'Prepaid',
+  [AccountType.PROPERTY]: 'Property',
+  [AccountType.SAVINGS]: 'Savings',
+}
+
+export const AccountIcon: any = {
+  [AccountType.ANY]: 'account_balance',
+  [AccountType.CASH]: 'monetization_on',
+  [AccountType.CHECKING]: 'checkbook',
+  [AccountType.CHECKING_LINE_OF_CREDIT]: 'checkbook', // Checking line of credit has the same icon as checking
+  [AccountType.CREDIT_CARD]: 'credit_card',
+  [AccountType.DIGITAL_WALLET]: 'wallet',
+  [AccountType.INSURANCE]: 'monitor_heart',
+  [AccountType.INVESTMENT]: 'trending_up',
+  [AccountType.LINE_OF_CREDIT]: 'add_credit',
+  [AccountType.LOAN]: 'loans',
+  [AccountType.MORTGAGE]: 'house',
+  [AccountType.PREPAID]: 'credit_card',
+  [AccountType.PROPERTY]: 'key',
+  [AccountType.SAVINGS]: 'savings',
+}
+
+export const AccountIconVariants: any = {
+  [AccountType.INVESTMENT]: 'bid_landscape',
+}
+
+export const PropertyTypeName: any = {
+  [PropertyType.REAL_ESTATE]: 'Real Estate',
+  [PropertyType.VEHICLE]: 'Vehicle',
+  [PropertyType.ART]: 'Art',
+  [PropertyType.JEWELRY]: 'Jewelry',
+  [PropertyType.FURNITURE]: 'Furniture',
+  [PropertyType.APPLIANCES]: 'Appliances',
+  [PropertyType.COMPUTER]: 'Computer',
+  [PropertyType.ELECTRONICS]: 'Electronics',
+  [PropertyType.SPORTS_EQUIPMENT]: 'Sports Equipment',
+  [PropertyType.MISCELLANEOUS]: 'Miscellaneous',
+}
+
+export const PropertyIcon: any = {
+  [PropertyType.REAL_ESTATE]: 'home_work',
+  [PropertyType.VEHICLE]: 'directions_car',
+  [PropertyType.ART]: 'insert_photo',
+  [PropertyType.JEWELRY]: 'diamond',
+  [PropertyType.FURNITURE]: 'chair',
+  [PropertyType.APPLIANCES]: 'kitchen',
+  [PropertyType.COMPUTER]: 'computer',
+  [PropertyType.ELECTRONICS]: 'camera_alt',
+  [PropertyType.SPORTS_EQUIPMENT]: 'sports_baseball',
+  [PropertyType.MISCELLANEOUS]: 'monetization_on',
+}

package/src/common/types/Activity.ts

@@ -0,0 +1,31 @@
+import { RecurrenceTypes } from '../constants'
+
+export enum ActivityType {
+  Expense = 0,
+  Income = 1,
+}
+
+export enum ActivityStatus {
+  Paid = 0,
+  Missed = 1,
+  Upcoming = 2,
+}
+
+export interface Activity {
+  accountGuid?: string
+  activityStatus: ActivityStatus
+  activityType: ActivityType
+  amount: number
+  categoryGuid?: string
+  expectedDate: Date
+  occurredOnDate?: Date
+  name: string
+  institution?: string
+  institutionGuid?: string
+  merchantGuid?: string
+  recurrenceType: RecurrenceTypes
+  recurrenceDay?: number
+  scheduledPaymentGuid?: string
+  sequenceGuid?: string
+  transactionGuid?: string
+}

package/src/common/types/Analytics.ts

@@ -0,0 +1,70 @@
+import { analyticsSession } from '../utils/Analytics'
+
+export type AnalyticsEvent = {
+  analytics_event: {
+    action: string
+    app_version: string
+    category: string
+    created_at: string
+    host: string
+    label: string
+    name: string
+    session_id: string
+    user_agent: string
+    value: string | null
+    version: number
+  }
+}
+
+export type AnalyticsPageview = {
+  analytics_pageview: {
+    app_version: string
+    created_at: string
+    detailed_path: string
+    host: string
+    metadata: string | null
+    name: string
+    path: string
+    session_id: string
+    user_agent: string
+  }
+}
+
+export type BasicAnalyticsEvent = Pick<
+  AnalyticsEvent['analytics_event'],
+  'action' | 'category' | 'label' | 'value'
+>
+export type BasicAnalyticsPageview = Pick<
+  AnalyticsPageview['analytics_pageview'],
+  'name' | 'detailed_path' | 'metadata' | 'path'
+>
+
+export type AnalyticsSession = {
+  browser_name: string
+  browser_version: string
+  guid: string
+  is_first_visit: boolean
+  product_name: string
+  product_version: string
+}
+
+export type AnalyticEventFunction = (
+  event: string,
+  session?: Awaited<ReturnType<typeof analyticsSession>> | null,
+) => void
+
+export type AnalyticPageviewFunction = (
+  page: string,
+  session?: Awaited<ReturnType<typeof analyticsSession>> | null,
+) => void
+
+export interface AnalyticsEventsObjectType extends BasicAnalyticsEvent {
+  instanceId: string
+}
+
+export interface AnalyticsPageviewObjectType extends BasicAnalyticsPageview {
+  label: string
+  name: string
+  path: string
+  value: string
+}

package/src/common/types/Beat.ts

@@ -0,0 +1,71 @@
+import { Account } from './Account'
+import { Transaction } from './Transaction'
+
+export interface Beat {
+  account_guids: string[] | []
+  active_at?: string | number
+  associated_transaction_guid?: string | null
+  call_to_action?: string | null
+  category_guids?: string[] | []
+  created_at?: string | number
+  cta_clicked_at?: number | null
+  data_series: DataSeries
+  description?: string
+  digest?: string
+  dismissed_at?: number | null
+  displayed_at?: string | null
+  errors?: any
+  guid: string
+  has_been_displayed: boolean
+  html_description?: string
+  html_in_description_cta?: string
+  html_micro_call_to_action?: string
+  html_micro_description?: string
+  html_micro_title?: string
+  html_short_title?: string
+  html_title: string
+  icon_color?: string | null
+  icon_type?: number | null
+  in_description_cta?: string | null
+  is_dismissed: boolean
+  is_obsolete: boolean
+  is_refreshable: boolean
+  is_sampled: boolean
+  merchant_guids: string[] | []
+  metadata?: string | null
+  micro_call_to_action?: string | null
+  micro_description?: string | null
+  micro_title?: string | null
+  payload: any
+  primary_account?: Account
+  primary_account_guid?: string | null
+  primary_category_guid?: string | null
+  primary_goal_guid?: string | null
+  primary_merchant_guid?: string | null
+  primary_scheduled_payment_guid?: string | null
+  primary_transaction?: Transaction
+  primary_transaction_guid?: string | null
+  power_action_completed_at?: string | null
+  power_action_has_been_completed?: boolean
+  scheduled_payment_guids: string[] | []
+  short_title?: string | null
+  supporting_action?: string | null
+  template: string
+  title: string
+  transaction_guids: string[] | []
+  transactions?: Transaction[]
+  user_guid: string
+  user_verification: UserVerification
+}
+
+export interface DataSeries {
+  names?: string[]
+  types?: string[]
+  data?: any[]
+}
+
+export enum UserVerification {
+  UNKNOWN = 0,
+  CORRECT = 1,
+  INCORRECT = 2,
+}

package/src/common/types/Budget.ts

@@ -0,0 +1,29 @@
+import type { DetailedCategory } from './Category'
+
+export type BudgetColors = {
+  background: string
+  mercury: string
+  description: string
+  text: string
+}
+
+export interface Budget {
+  amount: number
+  category_guid: string
+  end_date?: number
+  flags?: string[]
+  guid: string
+  parent_guid?: string
+  revision: number
+  start_date: number
+  transaction_total: number
+  user_guid: string
+}
+
+export interface DetailedBudget extends Budget {
+  budgetColors: BudgetColors
+  category: DetailedCategory
+  description: string
+  percentage: number
+  subBudgets: DetailedBudget[]
+}

package/src/common/types/Cashflow.ts

@@ -0,0 +1,110 @@
+import { TransactionType } from './Transaction'
+
+export type RepeatDay =
+  | '1'
+  | '2'
+  | '3'
+  | '4'
+  | '5'
+  | '6'
+  | '7'
+  | '8'
+  | '9'
+  | '10'
+  | '11'
+  | '12'
+  | '13'
+  | '14'
+  | '15'
+  | '16'
+  | '17'
+  | '18'
+  | '19'
+  | '20'
+  | '21'
+  | '22'
+  | '23'
+  | '24'
+  | '25'
+  | '26'
+  | '27'
+  | '28'
+  | '29'
+  | '30'
+  | '31'
+export type RepeatDayOfWeek =
+  | '0#0'
+  | '0#1'
+  | '0#2'
+  | '0#3'
+  | '0#4'
+  | '0#5'
+  | '0#6'
+  | '1#0'
+  | '1#1'
+  | '1#2'
+  | '1#3'
+  | '1#4'
+  | '1#5'
+  | '1#6'
+  | '2#0'
+  | '2#1'
+  | '2#2'
+  | '2#3'
+  | '2#4'
+  | '2#5'
+  | '2#6'
+  | '3#0'
+  | '3#1'
+  | '3#2'
+  | '3#3'
+  | '3#4'
+  | '3#5'
+  | '3#6'
+  | '4#0'
+  | '4#1'
+  | '4#2'
+  | '4#3'
+  | '4#4'
+  | '4#5'
+  | '4#6'
+export type RepeatInterval = '1' | '2' | '3'
+export type RepeatMonth = '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12'
+export type RepeatWeekday = '0' | '1' | '2' | '3' | '4' | '5' | '6'
+
+export interface CashflowEvent {
+  amount: number
+  cashflow_sequence_guid: string
+  category_guid?: string | null
+  created_at?: number | null
+  description: string
+  expected_date: number
+  guid?: string | null
+  is_skipped?: boolean
+  name: string
+  occurred_on?: number | null
+  start_date?: number | null
+  transaction_guid?: string | null
+  transaction_type: TransactionType
+  user_guid: string
+}
+
+export interface CashflowSequence {
+  account_guid: string
+  amount: number
+  category_guid?: string | null
+  description: string
+  end_date?: number | null
+  guid?: string | null
+  name: string
+  recurrence_description: string
+  repeat_day: RepeatDay | null
+  repeat_interval: RepeatInterval | null
+  repeat_month: RepeatMonth | null // "12",
+  repeat_week: string | null
+  repeat_weekday: RepeatWeekday | RepeatDayOfWeek | null
+  repeat_year: string | null //"2023",
+  start_date?: number | null
+  transaction_type: TransactionType
+  user_guid: string
+}