Structures

The following structures are available globally.

  • YNAB API client

    See more

    Declaration

    Swift

    public struct YNAB

  • Converts currency data from API responses into displayeable strings

    See more

    Declaration

    Swift

    public struct CurrencyFormatter : Sendable

  • Converts dates to and from API-friendly strings

    See more

    Declaration

    Swift

    public struct DateConverter : Sendable

  • Budget account model

    See more

    Declaration

    Swift

    public struct Account : Codable, Equatable, Sendable

  • Budget category

    See more

    Declaration

    Swift

    public struct Category : Codable, Equatable, Sendable

  • Category group model

    See more

    Declaration

    Swift

    public struct CategoryGroup : Codable, Equatable, Sendable

  • Category group including categories

    See more

    Declaration

    Swift

    public struct CategoryGroupWithCategories : Codable, Equatable, Sendable

  • Currency formatting settings

    See more

    Declaration

    Swift

    public struct CurrencyFormat : Codable, Equatable, Sendable

  • Date format settings

    See more

    Declaration

    Swift

    public struct DateFormat : Codable, Equatable, Sendable

  • Model for API errors

    See more

    Declaration

    Swift

    public struct ErrorDetail : Codable, Equatable, Sendable

  • Undocumented

    See more

    Declaration

    Swift

    public struct ExistingTransaction : Codable, Equatable, Sendable

  • Undocumented

    See more

    Declaration

    Swift

    public struct HybridTransaction : Codable, Equatable, Sendable

  • Represents a money movement between categories

    See more

    Declaration

    Swift

    public struct MoneyMovement : Codable, Equatable, Sendable

  • Represents a group of money movements

    See more

    Declaration

    Swift

    public struct MoneyMovementGroup : Codable, Equatable, Sendable

  • Month detail model

    See more

    Declaration

    Swift

    public struct MonthDetail : Codable, Equatable, Sendable

  • Month summary model

    See more

    Declaration

    Swift

    public struct MonthSummary : Codable, Equatable, Sendable

  • A model representing a new category to be created. Both name and categoryGroupId are required by the API.

    See more

    Declaration

    Swift

    public struct NewCategory : Codable, Equatable, Sendable

  • Undocumented

    See more

    Declaration

    Swift

    public struct NewTransaction : Codable, Equatable, Sendable

  • Payee model

    See more

    Declaration

    Swift

    public struct Payee : Codable, Equatable, Sendable

  • Payee location model

    See more

    Declaration

    Swift

    public struct PayeeLocation : Codable, Equatable, Sendable

  • Full plan model. This represents a complete plan export.

    See more

    Declaration

    Swift

    public struct PlanDetail : Codable, Equatable, Sendable

  • Plan settings model

    See more

    Declaration

    Swift

    public struct PlanSettings : Codable, Equatable, Sendable

  • Plan summary model

    See more

    Declaration

    Swift

    public struct PlanSummary : Codable, Equatable, Sendable

  • A model representing a category to be saved or updated

    See more

    Declaration

    Swift

    public struct SaveCategory : Codable, Equatable, Sendable

  • A model representing a category group to be saved or updated

    See more

    Declaration

    Swift

    public struct SaveCategoryGroup : Codable, Equatable, Sendable

  • A model representing a month category to be saved or updated

    See more

    Declaration

    Swift

    public struct SaveMonthCategory : Codable, Equatable, Sendable

  • A model representing a payee to be saved or updated

    See more

    Declaration

    Swift

    public struct SavePayee : Codable, Equatable, Sendable

  • A model representing a scheduled transaction to be saved or updated

    See more

    Declaration

    Swift

    public struct SaveScheduledTransaction : Codable, Equatable, Sendable

  • A model representing a subtransaction to be saved

    See more

    Declaration

    Swift

    public struct SaveSubTransaction : Codable, Equatable, Sendable

  • Undocumented

    See more

    Declaration

    Swift

    public struct SaveTransactionWithIdOrImportId : Codable, Equatable, Sendable

  • Scheduled sub transaction

    See more

    Declaration

    Swift

    public struct ScheduledSubTransaction : Codable, Equatable, Sendable

  • Full details of a scheduled transaction

    See more

    Declaration

    Swift

    public struct ScheduledTransactionDetail : Codable, Equatable, Sendable

  • Summary of a scheduled transaction

    See more

    Declaration

    Swift

    public struct ScheduledTransactionSummary : Codable, Equatable, Sendable

  • Subtransaction model

    See more

    Declaration

    Swift

    public struct SubTransaction : Codable, Equatable, Sendable

  • Detailed model of a transaction

    See more

    Declaration

    Swift

    public struct TransactionDetail : Codable, Equatable, Sendable

  • Summary details of a transaction

    See more

    Declaration

    Swift

    public struct TransactionSummary : Codable, Equatable, Sendable

  • Authenticate user information

    See more

    Declaration

    Swift

    public struct User : Codable, Equatable, Sendable

  • Response returned when fetching the accounts in a plan

    See more

    Declaration

    Swift

    public struct AccountsResponse : Equatable, Sendable

  • Response returned when fetching the categories in a plan

    See more

    Declaration

    Swift

    public struct CategoriesResponse : Equatable, Sendable

  • Response returned when creating or updating a category group

    See more

    Declaration

    Swift

    public struct CategoryGroupResponse : Equatable, Sendable

  • Response returned when creating or updating a category

    See more

    Declaration

    Swift

    public struct CategoryResponse : Equatable, Sendable

  • Response returned when fetching transactions by category or payee

    See more

    Declaration

    Swift

    public struct HybridTransactionsResponse : Equatable, Sendable

  • Response returned when fetching the money movement groups in a plan

    See more

    Declaration

    Swift

    public struct MoneyMovementGroupsResponse : Equatable, Sendable

  • Response returned when fetching the money movements in a plan

    See more

    Declaration

    Swift

    public struct MoneyMovementsResponse : Equatable, Sendable

  • Response returned when fetching the months in a plan

    See more

    Declaration

    Swift

    public struct MonthsResponse : Equatable, Sendable

  • Response returned when creating or updating a payee

    See more

    Declaration

    Swift

    public struct PayeeResponse : Equatable, Sendable

  • Response returned when fetching the payees in a plan

    See more

    Declaration

    Swift

    public struct PayeesResponse : Equatable, Sendable

  • Response returned when fetching a single plan

    See more

    Declaration

    Swift

    public struct PlanResponse : Equatable, Sendable

  • Response returned when creating a single transaction

    See more

    Declaration

    Swift

    public struct SaveTransactionResponse : Equatable, Sendable

  • Response returned when creating or updating multiple transactions

    See more

    Declaration

    Swift

    public struct SaveTransactionsResponse : Equatable, Sendable

  • Response returned when fetching the scheduled transactions in a plan

    See more

    Declaration

    Swift

    public struct ScheduledTransactionsResponse : Equatable, Sendable

  • Response returned by operations on a single transaction

    See more

    Declaration

    Swift

    public struct TransactionResponse : Equatable, Sendable

  • Response returned when fetching a list of transactions

    See more

    Declaration

    Swift

    public struct TransactionsResponse : Equatable, Sendable

  • Provides access to account operations

    See more

    Declaration

    Swift

    public struct AccountService
    extension AccountService: AccountServiceType

  • Provides access to category operations

    See more

    Declaration

    Swift

    public struct CategoryService
    extension CategoryService: CategoryServiceType

  • Provides access to money movement operations

    See more

    Declaration

    Swift

    public struct MoneyMovementService
    extension MoneyMovementService: MoneyMovementServiceType

  • Provides access to month operations

    See more

    Declaration

    Swift

    public struct MonthService
    extension MonthService: MonthServiceType

  • Provides access to payee location operations

    See more

    Declaration

    Swift

    public struct PayeeLocationService
    extension PayeeLocationService: PayeeLocationServiceType

  • Provides access to payee operations

    See more

    Declaration

    Swift

    public struct PayeeService
    extension PayeeService: PayeeServiceType

  • Provides access to plan operations

    See more

    Declaration

    Swift

    public struct PlanService
    extension PlanService: PlanServiceType

  • Provides access to scheduled transaction operations

    See more

    Declaration

    Swift

    public struct ScheduledTransactionService
    extension ScheduledTransactionService: ScheduledTransactionServiceType

  • Provides access to transaction operations

    See more

    Declaration

    Swift

    public struct TransactionService
    extension TransactionService: TransactionServiceType

  • Provides access to user operations

    See more

    Declaration

    Swift

    public struct UserService
    extension UserService: UserServiceType