MNFNetworthAccount

Objective-C

@interface MNFNetworthAccount : MNFObject

Swift

class MNFNetworthAccount : MNFObject

MNFNetworth represents the main networth class from which you fetch main info and lists with Networth information. Networth accounts

  • @abstract The ID of the networth account. @duscission this is an accountId and is therefore also applicable in MNFAccount

    Declaration

    Objective-C

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

    Swift

    var accountId: NSNumber { get }

  • @abstract The name of the networth account. @duscission Updating the account name will also affect the corresponding MNFAccount

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull accountName;

    Swift

    var accountName: String { get set }

  • @abstract The realmAccountTypeId of the networth account. @duscission This is identical to the the corresponding property in MNFAccount

    Declaration

    Objective-C

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

    Swift

    var accountTypeId: NSNumber { get }

  • @abstract A flag indicating whether the networth account has been imported by the system.

    Declaration

    Objective-C

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

    Swift

    var isImport: NSNumber { get }

  • @abstract A flag indicating whether the networth account has been created by the user @discussion Only manual accounts can be updated

    Declaration

    Objective-C

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

    Swift

    var isManual: NSNumber { get }

  • @abstract A flag indicating if the manual account should be included or excluded from net worth. @discussion Only manual accounts can be updated

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nonnull isExcluded;

    Swift

    var isExcluded: NSNumber { get set }

  • @abstract The net worth type. @discussion Should be either “Asset” or “Liability”.

    Declaration

    Objective-C

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

    Swift

    var netWorthType: String { get }

  • @abstract Current balance of the account. @discussion Must be a positive number. The service changes it according to the net worth type.

    Declaration

    Objective-C

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

    Swift

    var currentBalance: NSNumber { get }

  • @abstract List of balance history for the networth account. @discussion If fetched as a summery this list will include interpolated/estimated history values.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSArray<MNFNetworthBalanceHistory *> *_Nonnull history;

    Swift

    var history: [MNFNetworthBalanceHistory] { get }

  • Deprecated

    Deprecated, use accountTypeCategory instead

    @abstract Account type of the networth account. @discussion This is identical to the account type of the corresponding MNFAccount.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) MNF_DEPRECATED("Deprecated, use accountTypeCategory instead") MNFAccountType *accountType;

    Swift

    var accountType: MNFAccountType { get }

  • The account type category.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) MNFAccountCategory *_Nonnull accountTypeCategory;

    Swift

    var accountTypeCategory: MNFAccountCategory { get }

  • The currency code of the account.

    Declaration

    Objective-C

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

    Swift

    var currencyCode: String { get }

  • The current balance in user currency.

    Declaration

    Objective-C

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

    Swift

    var currentBalanceInUserCurrency: NSNumber { get }

  • @abstract Instantiates a new networth account object.

    Note

    To get the object, use one of the fetch methods.

    Declaration

    Objective-C

    + (nonnull MNFJob *)
    createWithInitialBalance:(nullable NSNumber *)initialBalance
                     balance:(nonnull NSNumber *)balance
           accountIdentifier:(nullable NSString *)accountIdentifier
                 displayName:(nonnull NSString *)displayName
                networthType:(nonnull NSString *)networthType
          initialBalanceDate:(nullable NSDate *)initialBalanceDate
                  completion:
                      (nullable MNFSingleNetworthAccountsCompletionHandler)
                          completion;

    Swift

    class func create(withInitialBalance initialBalance: NSNumber?, balance: NSNumber, accountIdentifier: String?, displayName: String, networthType: String, initialBalance initialBalanceDate: Date?, completion: MNFSingleNetworthAccountsCompletionHandler? = nil) -> MNFJob

    Parameters

    initialBalance

    The initial balance of the account at the time of initialBalancedate. If nil, balance will be used.
    balance

    The current balance of the networth account.
    accountIdentifier

    Identifier for the account set by the originating bank. This identifier is used when getting account statements.
    displayName

    The name of the networth account.
    networthType

    The networth type, either “Asset” or “Liability”.
    initialBalanceDate

    the initial date for balance history on the networth account. If nil [NSDate date] will be used.
    completion

    completion executing with an error or nil.

    Return Value

    an error or a new MNFNetworthAccount object. @discussion This will instantiate a new networth account object on the remote with the parameters specified and with isManual equal to true.

  • @abstract Fetches a networth account with the specified id.

    Declaration

    Objective-C

    + (nonnull MNFJob *)
    fetchWithId:(nonnull NSNumber *)identifier
     completion:(nullable MNFSingleNetworthAccountsCompletionHandler)completion;

    Swift

    class func fetch(withId identifier: NSNumber, completion: MNFSingleNetworthAccountsCompletionHandler? = nil) -> MNFJob

    Parameters

    identifier

    networth account id.
    completion

    completion executing with an error or result

    Return Value

    an MNFJob with result or error @discussion The balance history in these Networth objects wil NOT include interpolated/estimated history values. i.e. balance history which has been estimated if there is no existing history for a specific period. Note: Unknown account types are ignored

  • Deprecated

    Use method with skip and take instead.

    @abstract Fetches a list of networth accounts and balance history.

    Declaration

    Objective-C

    + (nonnull MNFJob *)
    fetchWithStartDate:(nonnull NSDate *)startDate
               endDate:(nonnull NSDate *)endDate
         interPolation:(BOOL)useInterpolation
            completion:(nullable MNFMultipleNetworthAccountsCompletionHandler)
                           completion;

    Swift

    class func fetch(withStart startDate: Date, end endDate: Date, interPolation useInterpolation: Bool, completion: MNFMultipleNetworthAccountsCompletionHandler? = nil) -> MNFJob

    Parameters

    startDate

    The minimum date of the balance history
    endDate

    The maximum date of the balance history
    useInterpolation

    If true, the API will return estimated values for months with no imported or manually added values.
    completion

    completion executing with an error or result

    Return Value

    An MNFJob containing an array of networth accounts or an error. @discussion Unknown account types are ignored

  • @abstract Fetches a list of networth accounts and balance history.

    Declaration

    Objective-C

    + (nonnull MNFJob *)
    fetchWithStartDate:(nonnull NSDate *)startDate
               endDate:(nonnull NSDate *)endDate
         interPolation:(BOOL)useInterpolation
                  skip:(nullable NSNumber *)skip
                  take:(nullable NSNumber *)take
            completion:(nullable MNFMultipleNetworthAccountsCompletionHandler)
                           completion;

    Swift

    class func fetch(withStart startDate: Date, end endDate: Date, interPolation useInterpolation: Bool, skip: NSNumber?, take: NSNumber?, completion: MNFMultipleNetworthAccountsCompletionHandler? = nil) -> MNFJob

    Parameters

    startDate

    The minimum date of the balance history
    endDate

    The maximum date of the balance history
    useInterpolation

    If true, the API will return estimated values for months with no imported or manually added values.
    skip

    Number of accounts to skip. Defaults to zero.
    take

    Number of accounts to take. If null returns all.
    completion

    completion executing with an error or result

    Return Value

    An MNFJob containing an array of networth accounts or an error. @discussion Unknown account types are ignored

  • @abstract Fetches a list of networth accounts and balance history.

    Declaration

    Objective-C

    + (nonnull MNFJob *)
    fetchWithStartDate:(nonnull NSDate *)startDate
               endDate:(nonnull NSDate *)endDate
      intervalGrouping:(nonnull NSString *)intervalGrouping
                  skip:(nullable NSNumber *)skip
                  take:(nullable NSNumber *)take
            completion:(nullable MNFMultipleNetworthAccountsCompletionHandler)
                           completion;

    Swift

    class func fetch(withStart startDate: Date, end endDate: Date, intervalGrouping: String, skip: NSNumber?, take: NSNumber?, completion: MNFMultipleNetworthAccountsCompletionHandler? = nil) -> MNFJob

    Parameters

    startDate

    The minimum date of the balance history
    endDate

    The maximum date of the balance history
    intervalGrouping

    An interval enum indicating what balance history entries should be returned Possible values are ‘Dailey’, ‘Monthly’ and ‘Yearly’.
    skip

    Number of accounts to skip. Defaults to zero.
    take

    Number of accounts to take. If null returns all.
    completion

    completion executing with an error or result

    Return Value

    An MNFJob containing an array of networth accounts or an error. @discussion Unknown account types are ignored

  • @abstract Fetches the date of the first entry in the networth balance history

    Declaration

    Objective-C

    + (nonnull MNFJob *)
    firstEntrydateWithExcludedAccounts:(BOOL)excludedAccounts
                            completion:
                                (nullable
                                     MNFSingleNetworthBalanceHistoryCompletionHandler)
                                    completion;

    Swift

    class func firstEntrydate(withExcludedAccounts excludedAccounts: Bool, completion: MNFSingleNetworthBalanceHistoryCompletionHandler? = nil) -> MNFJob

    Parameters

    excludedAccounts

    Flag indicating if accounts that are excluded from net worth should be excluded.
    completion

    completion executing with an error or result

    Return Value

    Returns an MNFJob with result or error.

  • @abstract Fetches the available networth account types.

    Declaration

    Objective-C

    + (nonnull MNFJob *)fetchNetworthTypesWithCompletion:
    (nonnull MNFMultipleAccountTypesCompletionHandler)completion;

    Swift

    class func fetchNetworthTypes(completion: @escaping MNFMultipleAccountTypesCompletionHandler) -> MNFJob

    Parameters

    completion

    completion executing with an error or result

    Return Value

    Returns an MNFJob with results or error.

  • @abstract Refreshes the account with data from the server.

    Declaration

    Objective-C

    - (nonnull MNFJob *)refreshWithCompletion:
    (nullable MNFErrorOnlyCompletionHandler)completion;

    Swift

    func refresh(completion: MNFErrorOnlyCompletionHandler? = nil) -> MNFJob

    Parameters

    completion

    A completion block returns an error.

    Return Value

    MNFJob A job containing an error.

  • @abstract Updates the current networth account with name and visibility

    Declaration

    Objective-C

    - (nonnull MNFJob *)saveWithCompletion:
    (nullable MNFErrorOnlyCompletionHandler)completion;

    Swift

    func save(completion: MNFErrorOnlyCompletionHandler? = nil) -> MNFJob

    Parameters

    completion

    completion executing with an error or nil.

    Return Value

    Returns an MNFJob with result or error. @discussion Only networth accounts which are manually created can be updated

  • @abstract Deletes the account from networth.

    Declaration

    Objective-C

    - (nonnull MNFJob *)deleteAccountWithCompletion:
    (nullable MNFErrorOnlyCompletionHandler)completion;

    Swift

    func delete(completion: MNFErrorOnlyCompletionHandler? = nil) -> MNFJob

    Parameters

    completion

    completion executing with an error or nil.

    Return Value

    MNFJob A job containing a result or an error. The task result will always be nil. @discussion This will remove the entity and all history for the current networth account. NOTE: Only manually added accounts can be deleted

  • @abstract Adds the balance history to the networth.

    Declaration

    Objective-C

    - (nonnull MNFJob *)
    addBalanceHistory:(nonnull MNFNetworthBalanceHistory *)balanceHistory
           completion:(nullable MNFErrorOnlyCompletionHandler)completion;

    Swift

    func add(_ balanceHistory: MNFNetworthBalanceHistory, completion: MNFErrorOnlyCompletionHandler? = nil) -> MNFJob

    Parameters

    balanceHistory

    An MNFNetworthBalanceHistory object containing date and balance.
    completion

    completion executing with an error or nil.

    Return Value

    MNFJob A job containing an error. @discussion This will add the balance history entry to the networth NOTE: You can only add balance history to manually created accounts