plaid2.model.taxform module

class plaid2.model.taxform.Taxform(*, document_type: str, w_2: Optional[W2] = None, doc_id: Optional[str] = None)

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

doc_id: Optional[str]

An identifier of the document referenced by the document metadata.

document_type: str

The type of tax document. Currently, the only supported value is w2.

json(**kwargs: Any) → str

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → Taxform

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → Taxform

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

w_2: Optional[W2]

W2 is an object that represents income data taken from a W2 tax document.