API リファレンス

KakeiboClient(
    base_url: str,
    api_key: str,
    *,
    timeout: float = 30.0,
    http_client: httpx.Client | None = None,
)

create_journal(
    *,
    date: date | datetime | str,
    description: str,
    lines: list[JournalLine],
    source: str = "api",
    draft_id: int | None = None,
) -> JournalCreateResponse

get_journal(journal_id: int) -> JournalDetail

list_journals(
    *,
    date_from: date | datetime | str | None = None,
    date_to: date | datetime | str | None = None,
    page: int = 1,
    per_page: int = 20,
) -> JournalListResponse

delete_journal(journal_id: int) -> None

analyze(
    image: str | Path | bytes,
    *,
    comment: str = "",
    notify: bool = False,
    mime_type: str | None = None,
) -> AnalyzeResponse

list_drafts(
    *,
    status: str = "analyzed",
    page: int = 1,
    per_page: int = 50,
) -> DraftListResponse

get_draft(draft_id: int) -> DraftDetail

delete_draft(draft_id: int) -> None

close() -> None

@dataclass
class JournalLine:
    account_id: int
    debit: int = 0
    credit: int = 0
    description: str = ""

@dataclass
class JournalCreateResponse:
    id: int
    entry_number: int

@dataclass
class JournalDetail:
    id: int
    date: str
    entry_number: int
    description: str
    source: str
    lines: list[JournalLine]

@dataclass
class JournalListResponse:
    journals: list[JournalDetail]
    total: int
    page: int
    per_page: int

@dataclass
class AnalyzeResponse:
    draft_id: int
    suggestions: list[dict]

@dataclass
class DraftSummary:
    title: str = ""
    date: str = ""
    description: str = ""
    amount: int = 0
    suggestion_count: int = 0

@dataclass
class DraftListItem:
    id: int
    status: str
    comment: str
    created_at: str
    summary: DraftSummary | None = None

@dataclass
class DraftListResponse:
    drafts: list[DraftListItem]
    total: int
    page: int
    per_page: int

@dataclass
class DraftDetail:
    id: int
    status: str
    comment: str
    created_at: str
    summary: DraftSummary | None = None
    suggestions: list[dict] = field(default_factory=list)

class KakeiboAPIError(Exception):
    status_code: int   # HTTP ステータスコード
    message: str       # サーバーからのエラーメッセージ

class AuthenticationError(KakeiboAPIError):
    # status_code は常に 401