YNAB

List all YNAB budgets

Returns the YNAB budgets synced from this connection.

GET

/destinations/ynab/connections/{connectionId}/budgets

curl --request GET \
  --url https://api.synci.io/api/v1/destinations/ynab/connections/{connectionId}/budgets \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "accounts": [
        {
          "balance": "<string>",
          "budget": {},
          "budget_id": "<string>",
          "cleared_balance": "<string>",
          "closed": "<string>",
          "created_at": "<string>",
          "direct_import_linked": "<string>",
          "health": {
            "failure_count": "<string>",
            "integrator_message": "<string>",
            "last_attempt_at": "<string>",
            "status": "<string>",
            "transient_failure_count": "<string>",
            "transient_message": "<string>"
          },
          "id": "<string>",
          "last_reconciled_at": "<string>",
          "name": "<string>",
          "note": "<string>",
          "on_budget": "<string>",
          "transfer_links": [
            {
              "active": "<string>",
              "created_at": "<string>",
              "destination": {},
              "destination_id": "<string>",
              "destination_type": "<string>",
              "financial_account": {
                "account_category": "<string>",
                "account_number_masked": "<string>",
                "account_usage": "<string>",
                "balance": {
                  "available": "<any>",
                  "cleared": "<any>"
                },
                "balances_last_synced_at": "<string>",
                "bban": "<string>",
                "bic": "<string>",
                "cash_account_type": "<string>",
                "cash_balance": {
                  "amount": "<string>",
                  "currency": "<string>"
                },
                "config": {
                  "enrichment": {},
                  "fields_for_duplicate_filtering": [],
                  "fuzzy_counterparty_matching": "<string>",
                  "fuzzy_counterparty_min_chars": "<string>",
                  "map_fields": {},
                  "pending_settlement_matching": "<string>",
                  "pending_settlement_max_days": "<string>",
                  "sync_auto": "<string>",
                  "sync_balances": "<string>",
                  "sync_frequency_in_minutes": "<string>",
                  "sync_pending_transactions": "<string>",
                  "sync_start_date": "2025-01-01"
                },
                "created_at": "<string>",
                "currency": "<string>",
                "custom_name": "<string>",
                "details": "<string>",
                "details_last_synced_at": "<string>",
                "display_name": "<string>",
                "enabled": "<string>",
                "financial_connection": {
                  "access_valid_for_days": "<string>",
                  "accounts_last_synced_at": "<string>",
                  "activated_at": "<string>",
                  "consent_expires_at": "<string>",
                  "created_at": "<string>",
                  "enabled": "<string>",
                  "financial_accounts": [],
                  "financial_accounts_count": "<string>",
                  "health": {},
                  "id": "<string>",

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

connectionIdintegerrequired

The YNAB connection ID

Query Parameters

page[size]integerquerydefault:25

The number of results that will be returned per page.

page[number]integerquery

The page number to start the pagination from.

filter[name]stringquery

Filter by budget name.

filter[currency]stringquery

Filter by budget currency.

filter[ynab_id]stringquery

Filter by the budget's ID in YNAB.

sortenum<string>[]querydefault:["-id"]

includeenum<string>[]query

Response

Paginated set of YnabBudgetResource

dataobject[]required

Show child attributes

linksobjectrequired

Show child attributes

metaobjectrequired

Show child attributes

Still need help? Ask the team