MNFUpcoming

Objective-C

@interface MNFUpcoming : MNFObject

Swift

class MNFUpcoming : MNFObject

The MNFUpcoming represents information on upcoming transactions created by the user.

Immutable properties

  • An identifier that connects invoices to scheduled payments to transactions in the external system.

    Declaration

    Objective-C

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

    Swift

    var bankReference: String { get }

  • The amount of the upcoming transaction in system currency.

    Declaration

    Objective-C

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

    Swift

    var amount: NSNumber { get }

  • The id of the actual transaction once booked.

    Declaration

    Objective-C

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

    Swift

    var transactionId: NSNumber { get }

  • The id of the invoice this upcoming transaction is based on.

    Declaration

    Objective-C

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

    Swift

    var invoiceId: NSNumber { get }

  • The id of the scheduled payment this upcoming transaction is based on.

    Declaration

    Objective-C

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

    Swift

    var scheduledPaymentId: NSNumber { get }

  • A list of comments related to the upcoming transaction.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSArray<MNFUpcomingComment *> *_Nonnull comments;

    Swift

    var comments: [MNFUpcomingComment] { get }

  • A list of possible reconcile matches.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSArray<MNFUpcomingReconcileScore *> *_Nonnull reconcileScores;

    Swift

    var reconcileScores: [MNFUpcomingReconcileScore] { get }

  • Details of the upcoming transaction. Only set when explicitly requested for.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) MNFUpcomingDetails *_Nonnull details;

    Swift

    var details: MNFUpcomingDetails { get }

  • The recurring pattern this upcoming transaction was created from.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) MNFUpcomingRecurringPattern *_Nonnull recurringPattern;

    Swift

    var recurringPattern: MNFUpcomingRecurringPattern { get }

Mutable properties

  • The title or subject of the transaction.

    Declaration

    Objective-C

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

    Swift

    var text: String { get set }

  • The amount for the upcoming transaction in the currency of the ‘CurrencyCode’.

    Declaration

    Objective-C

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

    Swift

    var amountInCurrency: NSNumber { get set }

  • The ISO 4217 currency code of the ‘AmountInCurrency’.

    Declaration

    Objective-C

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

    Swift

    var currencyCode: String { get set }

  • The expected payment date of the upcoming transaction.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nonnull date;

    Swift

    var date: Date { get set }

  • Whether the upcoming transaction is flagged by the user.

    Declaration

    Objective-C

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

    Swift

    var isFlagged: NSNumber { get set }

  • Whether the upcoming transaction is added to the watched list.

    Declaration

    Objective-C

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

    Swift

    var isWatched: NSNumber { get set }

  • The id of the account the upcoming transaction is expected to be booked from.

    Declaration

    Objective-C

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

    Swift

    var accountId: NSNumber { get set }

  • The id of the category this upcoming transaction has been categorized as.

    Declaration

    Objective-C

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

    Swift

    var categoryId: NSNumber { get set }

  • The payment status of the upcoming payment. Either ‘Open’,‘Paid’ or ‘OnHold’.

    Declaration

    Objective-C

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

    Swift

    var paymentStatus: String { get set }

Fetching

  • Fetches an upcoming transaction with a given identifier.

    Declaration

    Objective-C

    + (nonnull MNFJob *)fetchUpcomingWithId:(nonnull NSNumber *)upcomingId
                             completion:(nullable MNFUpcomingCompletionHandler)
                                            completion;

    Swift

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

    Parameters

    upcomingId

    The identifier of the upcoming transaction.
    completion

    A completion handler returning an upcoming transaction and an error.

    Return Value

    MNFJob A job containing a result, metadata and an error.

  • Fetches a list of upcoming transactions in the given time period.

    Declaration

    Objective-C

    + (nonnull MNFJob *)
    fetchUpcomingFromDate:(nonnull NSDate *)fromDate
                   toDate:(nonnull NSDate *)toDate
               completion:
                   (nullable MNFMultipleUpcomingCompletionHandler)completion;

    Swift

    class func fetch(from fromDate: Date, to toDate: Date, completion: MNFMultipleUpcomingCompletionHandler? = nil) -> MNFJob

    Parameters

    fromDate

    The starting date of the time period.
    toDate

    The end date of the time period.
    completion

    A completion block returning a list of upcoming transactions and an error.

    Return Value

    MNFJob A job containing a list of upcoming transactions, metadata and an error.

  • Fetches a list of upcoming transactions in the given time period and filtered by optional parameters.

    Declaration

    Objective-C

    + (nonnull MNFJob *)
    fetchUpcomingFromDate:(nonnull NSDate *)fromDate
                   toDate:(nonnull NSDate *)toDate
               accountIds:(nullable NSString *)accountIds
           includeDetails:(BOOL)includeDetails
              watchedOnly:(BOOL)watchedOnly
       recurringPatternId:(nullable NSNumber *)recurringPatternId
            paymentStatus:(MNFUpcomingPaymentStatus)paymentStatus
               completion:
                   (nullable MNFMultipleUpcomingCompletionHandler)completion;

    Swift

    class func fetch(from fromDate: Date, to toDate: Date, accountIds: String?, includeDetails: Bool, watchedOnly: Bool, recurringPatternId: NSNumber?, paymentStatus: MNFUpcomingPaymentStatus, completion: MNFMultipleUpcomingCompletionHandler? = nil) -> MNFJob

    Parameters

    fromDate

    The starting date of the time period.
    toDate

    The end date of the time period.
    accountIds

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

    Whether the result should include details on upcoming transactions.
    watchedOnly

    Whether the result should return only watched transactions.
    recurringPatternId

    The id of the recurring pattern of the upcoming transactions.
    paymentStatus

    The payment status to filter by.
    completion

    A completion block returning a list of upcoming transactions and an error.

    Return Value

    MNFJob A job containing a list of upcoming transactions, metadata and an error.

Creating

  • Creates new upcoming transactions with the give parameters and an optional recurring pattern.

    Declaration

    Objective-C

    + (nonnull MNFJob *)
    createUpcomingWithText:(nonnull NSString *)text
          amountInCurrency:(nonnull NSNumber *)amountInCurrency
              currencyCode:(nullable NSString *)currencyCode
                      date:(nonnull NSDate *)date
                 accountId:(nullable NSNumber *)accountId
                categoryId:(nullable NSNumber *)categoryId
                 isFlagged:(nullable NSNumber *)isFlagged
                 isWatched:(nullable NSNumber *)isWatched
          recurringPattern:
              (nullable MNFUpcomingRecurringPattern *)recurringPattern
                completion:
                    (nullable MNFMultipleUpcomingCompletionHandler)completion;

    Swift

    class func createUpcoming(withText text: String, amountInCurrency: NSNumber, currencyCode: String?, date: Date, accountId: NSNumber?, categoryId: NSNumber?, isFlagged: NSNumber?, isWatched: NSNumber?, recurringPattern: MNFUpcomingRecurringPattern?, completion: MNFMultipleUpcomingCompletionHandler? = nil) -> MNFJob

    Parameters

    text

    The title or subject of the transaction.
    amountInCurrency

    The amount in currency of the transaction.
    currencyCode

    The ISO 4217 currency code of the transaction.
    date

    The date of the transaction.
    accountId

    The account id of the account the upcoming transaction is expected to be booked from.
    categoryId

    The category id of the transaction.
    isFlagged

    Whether the transaction is flagged.
    isWatched

    Whether the transaction will be added to a watch list.
    recurringPattern

    A recurring pattern for the transaction. This will potentially created many upcoming transactions.
    completion

    A completion block returning a list of upcoming transactions and an error.

    Return Value

    MNFJob A job containing a list of upcoming transactions, metadata and an error.

Deleting

  • Deletes the upcoming transaction from the server.

    Note

    Remember to deallocate objects that have been deleted on the server.

    Declaration

    Objective-C

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

    Swift

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

    Parameters

    completion

    A completion block returning an error.

    Return Value

    MNFJob A job containing an error.

Saving

  • Save any local changes to the upcoming transaction to the server.

    Note

    Remember to revert an object if saving is unsuccessful to be in sync with the server data.

    Declaration

    Objective-C

    - (nonnull MNFJob *)saveAllInSeries:(BOOL)allInSeries
                     withCompletion:
                         (nullable MNFErrorOnlyCompletionHandler)completion;

    Swift

    func saveAll(inSeries allInSeries: Bool, withCompletion completion: MNFErrorOnlyCompletionHandler? = nil) -> MNFJob

    Parameters

    completion

    A completion block returning an error.
    allInSeries

    Whether the change applies to all upcoming transactions made from the same repeat pattern.

    Return Value

    MNFJob A job containing an error.

Comment

  • Posts a comment on the upcoming transaction.

    Declaration

    Objective-C

    - (nonnull MNFJob *)postComment:(nonnull NSString *)comment
                 withCompletion:
                     (nullable MNFErrorOnlyCompletionHandler)completion;

    Swift

    func postComment(_ comment: String, withCompletion completion: MNFErrorOnlyCompletionHandler? = nil) -> MNFJob

    Parameters

    comment

    The comment to post.
    completion

    A completion block returning an error.

    Return Value

    MNFJob A job containing an error.

Accounts

  • Fetches the account id for the default account all upcoming transactions are expected to be booked from unless the user states otherwise.

    Declaration

    Objective-C

    + (nonnull MNFJob *)fetchDefaultAccountIdWithCompletion:
    (nullable MNFDefaultAccountIdCompletionHandler)completion;

    Swift

    class func fetchDefaultAccountId(completion: MNFDefaultAccountIdCompletionHandler? = nil) -> MNFJob

    Parameters

    completion

    A completion returning the default account id and an error.

    Return Value

    MNFJob A job containing the default account id and an error.

  • Sets the default account id.

    Declaration

    Objective-C

    + (nonnull MNFJob *)setDefaultAccountId:(nonnull NSNumber *)accountId
                         withCompletion:
                             (nullable MNFErrorOnlyCompletionHandler)completion;

    Swift

    class func setDefaultAccountId(_ accountId: NSNumber, withCompletion completion: MNFErrorOnlyCompletionHandler? = nil) -> MNFJob

    Parameters

    accountId

    The id of the account to be set as the default account.
    completion

    A completion block returning an error.

    Return Value

    MNFJob A job containing an error.

  • Fetches all the account ids for accounts that are included in the cash flow predicted accounts’ balances.

    Declaration

    Objective-C

    + (nonnull MNFJob *)fetchIncludedAccountIdsWithCompletion:
    (nullable MNFMultipleAccountIdsCompletionHandler)completion;

    Swift

    class func fetchIncludedAccountIds(completion: MNFMultipleAccountIdsCompletionHandler? = nil) -> MNFJob

    Parameters

    completion

    A completion block returning a list of account ids and an error.

    Return Value

    MNFJob A job containing a list of account ids and an error.

  • Sets the account ids of the accounts to be included in the cash flow predicted accounts’ balances.

    Declaration

    Objective-C

    + (nonnull MNFJob *)
    setIncludedAccountIds:(nonnull NSString *)accountIds
           withCompletion:(nullable MNFErrorOnlyCompletionHandler)completion;

    Swift

    class func setIncludedAccountIds(_ accountIds: String, withCompletion completion: MNFErrorOnlyCompletionHandler? = nil) -> MNFJob

    Parameters

    accountIds

    A comma seperated string of the account ids to be included.
    completion

    A completion block returning an error.

    Return Value

    MNFJob A job containing an error.