BudgetService

public struct BudgetService

Provides access to budget operations

  • Returns budgets list with summary information.

    Declaration

    Swift

    public func budgets(includeAccounts: Bool) async throws -> [BudgetSummary]

    Parameters

    includeAccounts

    Includes budget accounts in the response

    Return Value

    A list of budgets

  • Returns a single budget with all related entities.

    This is effectively a full budget export. Depending on the size of your budget, this request can take a while.

    Declaration

    Swift

    public func budget(
    budgetId: String,
    lastKnowledgeOfServer: Int? = nil
) async throws -> (BudgetDetail, ServerKnowledge)

    Parameters

    budgetId

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

    The starting server knowledge. If provided, only entities that have changed since lastKnowledgeOfServer will be included.

    Return Value

    A single budget and the last knowledge of the server

  • Returns settings for a budget.

    Declaration

    Swift

    public func budgetSettings(budgetId: String) async throws -> BudgetSettings

    Parameters

    budgetId

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

    Return Value

    Settings for a specific budget