PayeeService

public struct PayeeService

Provides access to payee operations

  • Returns all payees

    Declaration

    Swift

    public func payees(
    budgetId: String,
    lastKnowledgeOfServer: ServerKnowledge? = nil
) async throws -> [Payee]

    Parameters

    budgetId

    The id of the budget (last_used can also be used to specify the last used budget)
    lastKnowledgeOfServer

    If provided, only entities that have changed since lastKnowledgeOfServer will be included.

    Return Value

    A list of payees

  • Returns a single payee.

    Declaration

    Swift

    public func payee(budgetId: String, payeeId: String) async throws -> Payee

    Parameters

    budgetId

    The id of the budget (last_used can also be used to specify the last used budget)
    lastKnowledgeOfServer

    If provided, only entities that have changed since lastKnowledgeOfServer will be included.

    Return Value

    A single payee

  • Updates a single payee.

    Declaration

    Swift

    public func updatePayee(
    budgetId: String,
    payeeId: String,
    payee: SavePayee
) async throws -> (Payee, ServerKnowledge)

    Parameters

    budgetId

    The id of the budget (last_used can also be used to specify the last used budget)
    payeeId

    The id of the payee being update
    payee

    The details of the payee that need to be updated

    Return Value

    A single payee and the last server knowledge