Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/jbms/finance-dl/llms.txt

Use this file to discover all available pages before exploring further.

The finance_dl.waveapps scraper retrieves receipt images and extracted transaction data from WaveApps via the official WaveApps REST API. Unlike browser-based scrapers, this module communicates directly with the API using a Full Access token or OAuth2 credentials, making it faster and more reliable. All businesses accessible under the provided credentials are downloaded automatically.

​
Configuration Parameters

​
credentials
dict
required
A dictionary containing authentication credentials. You may authenticate with either a Full Access token or OAuth2 credentials.
​
output_directory
string
required
Path on the local filesystem where output files will be written. The directory is created automatically if it does not already exist.
​
use_business_directory
bool
When True, receipts for each business are written into a subdirectory of output_directory named after the business ID, rather than all into output_directory directly.
​
active_only
bool
When True, deleted receipts are skipped and only active receipts are downloaded.

​
Output Format

Receipts for all businesses accessible with the provided credentials are downloaded. When use_business_directory is True, receipts for each business are written into a subdirectory of output_directory named after the business ID; otherwise all receipts are written directly into output_directory. Inside each directory, the following files are written per receipt:
FileDescription
<receipt-id>.jsonJSON data returned by the WaveApps API for the receipt.
<receipt-id>.jpgPrimary receipt image in full resolution.
<receipt-id>.01.jpg, <receipt-id>.02.jpg, …Additional images, if present.
The JSON file contains at minimum the following fields:
FieldDescription
idUnique receipt identifier (matches <receipt-id> in the filename).
dateDate of the receipt.
merchantMerchant name.
noteOptional note attached to the receipt.
totalTotal amount.
currency_codeISO currency code (e.g., USD).

​
Config Example

def CONFIG_waveapps():
    return dict(
        module='finance_dl.waveapps',
        credentials=dict(
            token='XXXXXXXX',
        ),
        output_directory=os.path.join(data_dir, 'waveapps'),
    )

Build docs developers (and LLMs) love

Get started for freeTalk to us