Class ReceiptImportFlow

Drives receipt menus, smart-match, and transaction import.

Index

Constructors

Methods

setApi reply processPhoto showAccountMenu showCategoryMenu executeImport

Constructors

constructor

new ReceiptImportFlow(
deps: IReceiptFlowDeps,
ctx: IReceiptFlowContext,
): ReceiptImportFlow
Creates a ReceiptImportFlow.
Parameters
- deps: IReceiptFlowDeps
  OCR, notifiers, and optional Actual Budget API.
- ctx: IReceiptFlowContext
  Live conversation-state bridge from the handler.
Returns ReceiptImportFlow
- Defined in Services/Receipt/ReceiptImportFlow.ts:61

Methods

setApi

setApi(api: IReceiptActualApi): void
Sets the Actual Budget API after connection is established.
Parameters
- api: IReceiptActualApi
  The Actual Budget API instance.
Returns void
- Defined in Services/Receipt/ReceiptImportFlow.ts:74

reply

reply(text: string): Promise<Procedure<{ status: string }>>
Sends a text reply via the notifier.
Parameters
- text: string
  HTML text to send.
Returns Promise<Procedure<{ status: string }>>
Procedure indicating the reply result.
- Defined in Services/Receipt/ReceiptImportFlow.ts:81

processPhoto

processPhoto(fileId: string): Promise<Procedure<{ status: string }>>
Downloads, OCRs, parses the photo, then continues into match/menu display.
Parameters
- fileId: string
  Telegram file_id to download.
Returns Promise<Procedure<{ status: string }>>
Procedure indicating processing result.
- Defined in Services/Receipt/ReceiptImportFlow.ts:92

showAccountMenu

showAccountMenu(): Promise<Procedure<{ status: string }>>
Shows account selection inline keyboard.

Returns Promise<Procedure<{ status: string }>>
Procedure indicating menu was sent.
- Defined in Services/Receipt/ReceiptImportFlow.ts:111

showCategoryMenu

showCategoryMenu(): Promise<Procedure<{ status: string }>>
Shows category selection inline keyboard.

Returns Promise<Procedure<{ status: string }>>
Procedure indicating menu was sent.
- Defined in Services/Receipt/ReceiptImportFlow.ts:124

executeImport

executeImport(): Promise<Procedure<{ status: string }>>
Imports the receipt transaction into Actual Budget.

Returns Promise<Procedure<{ status: string }>>
Procedure indicating the import result.
- Defined in Services/Receipt/ReceiptImportFlow.ts:137