Skip to main content

Scanye Python Library and CLI

A Python library and CLI tool for interacting with the Scanye API.

Unofficial project. This library is not created, maintained, sponsored, or endorsed by Scanye. It's a community-built client for the unofficial Scanye API (api.scanye.pl), reverse-engineered from the Scanye web app's network traffic. Use at your own risk.

Features

  • Login and authentication
  • List sales and purchase invoices
  • Show a single invoice's details and history
  • Filter invoices by KSeF status
  • Send invoices to KSeF
  • E-mail invoices to buyers
  • Download invoices as PDF
  • CLI for easy access

Installation

pip install scanye-py

CLI Usage

First, login to your account:

scanye login --email your@email.com

List your sales invoices:

scanye invoices list --type sales

List purchase invoices that are not yet sent to KSeF:

scanye invoices list --type purchase --unsent

Show a single invoice's details and history:

scanye invoices show <invoice-id>

Download all sales and purchase invoices from a given month as PDF (multiple invoices are downloaded as a single ZIP and extracted automatically):

scanye invoices download --type sales --month 2026-07 -o ./invoices/2026-07/sales
scanye invoices download --type purchase --month 2026-07 -o ./invoices/2026-07/purchase

Download a single invoice by ID:

scanye invoices download <invoice-id> -o ./invoices

E-mail an invoice to its buyer:

scanye invoices send-email <invoice-id> --to buyer@example.com

Library Usage

from scanye.client import ScanyeClient

client = ScanyeClient()
client.login("your@email.com", "your_password")

invoices = client.fetch_invoices(is_sales=True)
for inv in invoices:
    print(f"{inv.invoice_no}: {inv.ksef_status}")

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scanye_py-0.2.2.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scanye_py-0.2.2-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

Details for the file scanye_py-0.2.2.tar.gz.

File metadata

  • Download URL: scanye_py-0.2.2.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for scanye_py-0.2.2.tar.gz
Algorithm Hash digest
SHA256 5947eabf416e31b9849d37864362efbb5e178cc4815a58e7c7de0dfa3de8b6b4
MD5 6aa1bab32ad83f1b0fba154d4bac8aff
BLAKE2b-256 e34c41f7f986ada5d03020439542f0ffbd59a52cbf9846c9fc8395ecab82f7b7

See more details on using hashes here.

Provenance

The following attestation bundles were made for scanye_py-0.2.2.tar.gz:

Publisher: ci.yml on theundefined/scanye-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file scanye_py-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: scanye_py-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 14.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for scanye_py-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f6670b8e34574265624f5caff989d8183c789387c517d997835d3529d302d307
MD5 f02df22797d4056642a2a63f242c7188
BLAKE2b-256 8032ac2f023ecb7b2682014ea8a29537bddca0edef1aeba1cb0008053747fe08

See more details on using hashes here.

Provenance

The following attestation bundles were made for scanye_py-0.2.2-py3-none-any.whl:

Publisher: ci.yml on theundefined/scanye-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.2.4

2 files

0.2.3

2 files

This release

0.2.2 This release

2 files

0.2.1

2 files

0.2.0

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page