Methods
getBudgetSummary
- getBudgetSummary(options): Promise<{
consumer: {
finance: {
budgets: {
spendSummary: {
budgetedLeftOverCash: number;
leftOverCash: number;
month: string;
totalBudgetedIncome: number;
totalBudgetedSpending: number;
totalExpensesBudget: number;
totalIncome: number;
totalIncomeBudget: number;
totalSpending: number;
totalUnbudgetedIncome: number;
totalUnbudgetedSpending: number;
}[];
unbudgetedExpenses: {
amount: number;
category: {
id: string;
name: string;
parentId: string;
parentName: string;
type: string;
};
categoryId: string;
date: string;
}[];
userBudgets: {
amount: number;
budgetAdjustmentAmount: unknown;
budgetAmount: number;
budgetDate: string;
budgetInterval: string;
budgetType: string;
id: string;
performanceStatus: string;
reset: boolean;
rollover: boolean;
source: {
categoryName: string;
categoryType: string;
id: string;
parentId: string;
parentName: string;
type: string;
};
subsumed: boolean;
}[];
};
};
};
}>
-
Returns Promise<{
consumer: {
finance: {
budgets: {
spendSummary: {
budgetedLeftOverCash: number;
leftOverCash: number;
month: string;
totalBudgetedIncome: number;
totalBudgetedSpending: number;
totalExpensesBudget: number;
totalIncome: number;
totalIncomeBudget: number;
totalSpending: number;
totalUnbudgetedIncome: number;
totalUnbudgetedSpending: number;
}[];
unbudgetedExpenses: {
amount: number;
category: {
id: string;
name: string;
parentId: string;
parentName: string;
type: string;
};
categoryId: string;
date: string;
}[];
userBudgets: {
amount: number;
budgetAdjustmentAmount: unknown;
budgetAmount: number;
budgetDate: string;
budgetInterval: string;
budgetType: string;
id: string;
performanceStatus: string;
reset: boolean;
rollover: boolean;
source: {
categoryName: string;
categoryType: string;
id: string;
parentId: string;
parentName: string;
type: string;
};
subsumed: boolean;
}[];
};
};
};
}>
getOverviewChart
- getOverviewChart(options): Promise<{
consumer: {
finance: {
mintOverviewChart: {
categoryId: unknown;
currency: string;
currentDate: string;
customDataPoints: {
date: string;
value: number;
}[];
dataPoints: {
date: string;
value: number;
}[];
delta: null | number;
forecastDataPoints: {
date: string;
value: number;
}[];
forecastedSpendingCategories: unknown[];
heroMainValue: number;
lookAlikeDataPoints: {
date: string;
value: number;
}[];
reportType: string;
subHeaderText: null | string;
subHeaderValue: null | number;
timeframe: string;
topCategories: unknown[];
topOverBudgetCategories: unknown[];
};
};
};
}>
-
Parameters
-
options: {
date: Date;
reportType: "SPENDING" | "NETWORTH";
timeframe: "_7D" | "_30D" | "_1Y" | "ALL";
}
-
date: Date
-
reportType: "SPENDING" | "NETWORTH"
-
timeframe: "_7D" | "_30D" | "_1Y" | "ALL"
Returns Promise<{
consumer: {
finance: {
mintOverviewChart: {
categoryId: unknown;
currency: string;
currentDate: string;
customDataPoints: {
date: string;
value: number;
}[];
dataPoints: {
date: string;
value: number;
}[];
delta: null | number;
forecastDataPoints: {
date: string;
value: number;
}[];
forecastedSpendingCategories: unknown[];
heroMainValue: number;
lookAlikeDataPoints: {
date: string;
value: number;
}[];
reportType: string;
subHeaderText: null | string;
subHeaderValue: null | number;
timeframe: string;
topCategories: unknown[];
topOverBudgetCategories: unknown[];
};
};
};
}>
Private query
- query<N>(operationName, query, variables): Promise<TQueries[N]["response"]>
-
Parameters
-
operationName: N
-
query: TQueries[N]["query"]
-
variables: TQueries[N]["variables"]
Returns Promise<TQueries[N]["response"]>