Validation error on GET /budget/:id

[elowing]

Hello! Getting this error when fetching my budget. Is it rejecting transactions with no flag set? Any insight?

budgets_api.get_budget_by_id("my-budget-id")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/Users/em/Library/Python/3.9/lib/python/site-packages/pydantic/_internal/_validate_call.py", line 39, in wrapper_function
    return wrapper(*args, **kwargs)
  File "/Users/em/Library/Python/3.9/lib/python/site-packages/pydantic/_internal/_validate_call.py", line 136, in __call__
    res = self.__pydantic_validator__.validate_python(pydantic_core.ArgsKwargs(args, kwargs))
  File "/Users/em/Library/Python/3.9/lib/python/site-packages/ynab/api/budgets_api.py", line 110, in get_budget_by_id
    return self.api_client.response_deserialize(
  File "/Users/em/Library/Python/3.9/lib/python/site-packages/ynab/api_client.py", line 319, in response_deserialize
    return_data = self.deserialize(response_text, response_type, content_type)
  File "/Users/em/Library/Python/3.9/lib/python/site-packages/ynab/api_client.py", line 420, in deserialize
    return self.__deserialize(data, response_type)
  File "/Users/em/Library/Python/3.9/lib/python/site-packages/ynab/api_client.py", line 467, in __deserialize
    return self.__deserialize_model(data, klass)
  File "/Users/em/Library/Python/3.9/lib/python/site-packages/ynab/api_client.py", line 797, in __deserialize_model
    return klass.from_dict(data)
  File "/Users/em/Library/Python/3.9/lib/python/site-packages/ynab/models/budget_detail_response.py", line 87, in from_dict
    "data": BudgetDetailResponseData.from_dict(obj["data"]) if obj.get("data") is not None else None
  File "/Users/em/Library/Python/3.9/lib/python/site-packages/ynab/models/budget_detail_response_data.py", line 88, in from_dict
    "budget": BudgetDetail.from_dict(obj["budget"]) if obj.get("budget") is not None else None,
  File "/Users/em/Library/Python/3.9/lib/python/site-packages/ynab/models/budget_detail.py", line 211, in from_dict
    "transactions": [TransactionSummary.from_dict(_item) for _item in obj["transactions"]] if obj.get("transactions") is not None else None,
  File "/Users/em/Library/Python/3.9/lib/python/site-packages/ynab/models/budget_detail.py", line 211, in <listcomp>
    "transactions": [TransactionSummary.from_dict(_item) for _item in obj["transactions"]] if obj.get("transactions") is not None else None,
  File "/Users/em/Library/Python/3.9/lib/python/site-packages/ynab/models/transaction_summary.py", line 173, in from_dict
    _obj = cls.model_validate({
  File "/Users/em/Library/Python/3.9/lib/python/site-packages/pydantic/main.py", line 703, in model_validate
    return cls.__pydantic_validator__.validate_python(
pydantic_core._pydantic_core.ValidationError: 1 validation error for TransactionSummary
flag_color
  Input should be 'red', 'orange', 'yellow', 'green', 'blue' or 'purple' [type=enum, input_value='', input_type=str]
    For further information visit https://errors.pydantic.dev/2.11/v/enum

[shockey]

I'm running into this too!

The API is indeed sending back a flag_color field with the empty string as a value for certain transactions:

curl -X 'GET' \
  'https://api.ynab.com/v1/budgets/00000000-0000-0000-0000-000000000000/transactions/00000000-0000-0000-0000-000000000000' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX' | jq '.data.transaction | {flag_color}'

{
  "flag_color": ""
}

This is incongruent with the OpenAPI spec checked in here, which only supports the six color strings as well as null on the field:

ynab-sdk-python/open_api_spec.yaml

Lines 3373 to 3384 in ae7a6af

	TransactionFlagColor:
	type: string
	description: The transaction flag
	enum:
	- red
	- orange
	- yellow
	- green
	- blue
	- purple
	- null
	nullable: true

That OpenAPI spec's version matches what's currently served on YNAB's Swagger UI instance (1.74.0 as of writing), so this repo is up to date in tracking it. Since it seems like this repo likes to track that upstream spec, I don't think we could simply open a PR that adds "" as a valid enum value and get this patched — YNAB's API team probably needs to fix the upstream definition.

I also don't see any options for selectively or globally bypassing the Pydantic response validation that the client performs, so I don't think there's an easy way to opt out of the incorrect validator.

Workaround

There is a way, though! This unblocked my use case:

    # Terrible hack to avoid an incorrect enum. Hopefully YNAB fixes this!
    # See https://github.com/ynab/ynab-sdk-python/issues/7
    from ynab.models.transaction_flag_color import TransactionFlagColor

    original_new = TransactionFlagColor.__new__

    def patched_new_coerce_empty_string_to_none(cls, value):
        if value == "":
            return None
        return original_new(cls, value)

    TransactionFlagColor.__new__ = patched_new_coerce_empty_string_to_none

[bradymholt]

Thanks for your patience here. This should now be fixed in 1.6.0.