MNFUpcomingBalance

Objective-C

@interface MNFUpcomingBalance : MNFObject

Swift

class MNFUpcomingBalance : MNFObject

The MNFUpcomingBalance class contains information of upcomings from today in a list of dates with balance.

Immutable properties

  • The starting balance for the balance projections, calculated as yesterday’s closing balance + todaysTransactionsAmount.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSNumber *_Nonnull startBalance;

    Swift

    var startBalance: NSNumber { get }

  • The projected end balance for the requested period.s

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSNumber *_Nonnull endBalance;

    Swift

    var endBalance: NSNumber { get }

  • A sum of today’s transactions amounts for the accounts selected.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSNumber *_Nonnull todaysTransactionsAmount;

    Swift

    var todaysTransactionsAmount: NSNumber { get }

  • The currency of the upcoming transaction.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull currency;

    Swift

    var currency: String { get }

  • A list of dates and their predictes balances.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSArray<MNFUpcomingBalanceDate *> *_Nonnull balanceDates;

    Swift

    var balanceDates: [MNFUpcomingBalanceDate] { get }

  • Fetches upcoming balances from to day until the specified date.

    Declaration

    Objective-C

    + (nonnull MNFJob *)
    fetchBalancesWithDateTo:(nonnull NSDate *)dateTo
     includeOverdueFromDate:(nullable NSDate *)overdueFromDate
                 accountIds:(nullable NSString *)accountIds
            includeUnlinked:(BOOL)includeUnlinked
         useAvailableAmount:(BOOL)useAvailableAmount
                 completion:(nullable MNFBalancesCompletionHandler)completion;

    Swift

    class func fetchBalancesWithDate(to dateTo: Date, includeOverdueFrom overdueFromDate: Date?, accountIds: String?, includeUnlinked: Bool, useAvailableAmount: Bool, completion: MNFBalancesCompletionHandler? = nil) -> MNFJob

    Parameters

    dateTo

    The inclusive end date of the entries to be fetched.
    overdueFromDate

    When set the open upcoming transactions from this date (inclusive) are projected to today’s balance.
    accountIds

    A comma seperated string of account ids to filter by.
    includeUnlinked

    Whether upcomings that are not linked to any account should be included.
    useAvailableAmount

    Whether the amount of accounts should be the available amount or the real amount.
    completion

    A completion block returning a balance and an error.

    Return Value

    MNFJob A job containing a balance and an error.