Skip to main content

Tochka API wrapper for Python built on top of httpx and pydantic

Project description

tochka_py

Tochka API docs - Sandbox docs

Python-клиент для Tochka API на базе httpx и pydantic.

Сейчас библиотека покрывает:

  • tochka_py.invoice - полный lifecycle работы со счетами: create, get_file, send_to_email, get_payment_status, delete
  • tochka_py.closing_documents - работа с закрывающими документами: create, get_file, send_to_email, delete
  • tochka_py.webhook - управление webhook-подписками и верификация входящих webhook JWT: create, edit, get, send_test, delete, WebhookVerifier

Поддерживаются синхронные и асинхронные вызовы, единый transport и типизированные модели запросов и ответов.

Также доступен CLI tochka-py для управления webhook-подписками.

Установка

pip install tochka_py

Требуется Python >=3.10.

Если запускаете CLI из репозитория и команда tochka-py отдает старую версию, активируйте локальное окружение через source .venv/bin/activate.

Быстрый старт

from tochka_py import TochkaClient
from tochka_py.invoice.types import (
    ContentInvoice,
    CounterpartType,
    InvoiceCreateRequest,
    InvoiceCreateRequestData,
    InvoiceModel,
    NdsKind,
    PositionModel,
    SecondSideModel,
    UnitCode,
)

request = InvoiceCreateRequestData(
    data=InvoiceCreateRequest(
        account_id="12345123451234512345/044525104",
        customer_code="1234567ab",
        second_side=SecondSideModel(
            tax_code="7707083893",
            type=CounterpartType.COMPANY,
            second_side_name='ООО "Покупатель"',
        ),
        content=ContentInvoice(
            invoice=InvoiceModel(
                number="42",
                total_amount=1000.0,
                positions=[
                    PositionModel(
                        position_name="Консультационные услуги",
                        unit_code=UnitCode.PIECE,
                        nds_kind=NdsKind.WITHOUT_NDS,
                        price=1000.0,
                        quantity=1,
                        total_amount=1000.0,
                    )
                ],
            )
        ),
    )
)

with TochkaClient(token="your_token") as client:
    response = client.invoice.create_sync(request)

print(response.data.document_id)

Получение PDF, статуса оплаты, отправка на email и удаление:

from tochka_py.invoice.types import SendDocumentToEmailRequest

document_id = response.data.document_id
customer_code = request.customer_code

with TochkaClient(token="your_token") as client:
    payment_status = client.invoice.get_payment_status_sync(customer_code, document_id)
    pdf_file = client.invoice.get_file_sync(customer_code, document_id)
    email_result = client.invoice.send_to_email_sync(
        customer_code,
        document_id,
        SendDocumentToEmailRequest(email="test@example.com"),
    )
    delete_result = client.invoice.delete_sync(customer_code, document_id)

print(payment_status.data.payment_status)
print(pdf_file.filename, pdf_file.content_type, len(pdf_file.content))
print(email_result.data.result, delete_result.data.result)

Closing Documents

Создание закрывающего документа, например акта:

from decimal import Decimal

from tochka_py import TochkaClient
from tochka_py.closing_documents.types import (
    ActModel,
    ClosingDocumentCreateRequest,
    ContentAct,
    SecondSideModel,
)
from tochka_py.invoice.types import CounterpartType, NdsKind, PositionModel, UnitCode

request = ClosingDocumentCreateRequest(
    account_id="12345123451234512345/044525104",
    customer_code="1234567ab",
    second_side=SecondSideModel(
        tax_code="7707083893",
        type=CounterpartType.COMPANY,
    ),
    content=ContentAct(
        act=ActModel(
            number="ACT-42",
            total_amount=Decimal("1000.00"),
            positions=[
                PositionModel(
                    position_name="Консультационные услуги",
                    unit_code=UnitCode.PIECE,
                    nds_kind=NdsKind.WITHOUT_NDS,
                    price=Decimal("1000.00"),
                    quantity=Decimal("1"),
                    total_amount=Decimal("1000.00"),
                )
            ],
        )
    ),
)

with TochkaClient(token="your_token") as client:
    response = client.closing_documents.create_sync(request)

print(response.data.document_id)

Webhooks

Управление webhook-подпиской:

from tochka_py import TochkaClient
from tochka_py.webhook.types import WebhookSubscription, WebhookType

with TochkaClient(token="your_token") as client:
    response = client.webhooks.create_sync(
        client_id="your_app_client_id",
        request=WebhookSubscription(
            webhooks_list=[
                WebhookType.INCOMING_PAYMENT,
                WebhookType.OUTGOING_PAYMENT,
            ],
            url="https://app.example.com/tochka/webhook",
        ),
    )

print(response.data.webhooks_list, response.data.url)

Верификация и парсинг входящего webhook JWT:

from tochka_py.webhook.verifier import WebhookVerifier

raw_webhook_jwt = request_body.decode()

with WebhookVerifier() as verifier:
    payload = verifier.decode_sync(raw_webhook_jwt)

print(payload.webhook_type, payload.customer_code)

CLI

Повесить webhook одной командой:

export TOCHKA_API_TOKEN=your_token
tochka-py webhook set \
  --client-id your_app_client_id \
  --url https://app.example.com/tochka/webhook \
  --event incomingPayment \
  --event outgoingPayment

Получить список счетов:

tochka-py accounts list

Посмотреть текущую подписку:

tochka-py webhook get --client-id your_app_client_id

Отправить тестовый webhook:

tochka-py webhook test --client-id your_app_client_id --event incomingPayment

Удалить подписку:

tochka-py webhook delete --client-id your_app_client_id

CLI использует:

  • TOCHKA_API_TOKEN для токена
  • TOCHKA_BASE_URL для переопределения base URL
  • --sandbox для переключения на https://enter.tochka.com/sandbox/v2 и дефолтный токен sandbox.jwt.token

Для sandbox можно использовать:

  • base URL: https://enter.tochka.com/sandbox/v2
  • токен: sandbox.jwt.token

Структура API

from tochka_py import TochkaClient

TochkaClient:

  • invoice.create_sync(...)
  • invoice.create(...)
  • invoice.get_file_sync(...)
  • invoice.get_file(...)
  • invoice.send_to_email_sync(...)
  • invoice.send_to_email(...)
  • invoice.get_payment_status_sync(...)
  • invoice.get_payment_status(...)
  • invoice.delete_sync(...)
  • invoice.delete(...)
  • closing_documents.create_sync(...)
  • closing_documents.create(...)
  • closing_documents.get_file_sync(...)
  • closing_documents.get_file(...)
  • closing_documents.send_to_email_sync(...)
  • closing_documents.send_to_email(...)
  • closing_documents.delete_sync(...)
  • closing_documents.delete(...)
  • webhooks.create_sync(...)
  • webhooks.create(...)
  • webhooks.edit_sync(...)
  • webhooks.edit(...)
  • webhooks.get_sync(...)
  • webhooks.get(...)
  • webhooks.send_test_sync(...)
  • webhooks.send_test(...)
  • webhooks.delete_sync(...)
  • webhooks.delete(...)
  • webhooks.set_sync(...)
  • webhooks.set(...)

Обработка ошибок

Библиотека поднимает исключения из tochka_py.core.errors, например:

  • AuthenticationError
  • RequestValidationError
  • NotFoundError
  • ServerError

У исключений доступны поля product, http_status, code, request_id и raw.

Интеграционные тесты для sandbox

По умолчанию интеграционные тесты отключены.

Запуск unit-тестов:

uv run pytest tests

Запуск integration:

uv run pytest tests -m integration

Project details


Download files

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

Source Distribution

tochka_py-0.0.5.tar.gz (58.2 kB view details)

Uploaded Source

Built Distribution

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

tochka_py-0.0.5-py3-none-any.whl (23.4 kB view details)

Uploaded Python 3

File details

Details for the file tochka_py-0.0.5.tar.gz.

File metadata

  • Download URL: tochka_py-0.0.5.tar.gz
  • Upload date:
  • Size: 58.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.1 {"installer":{"name":"uv","version":"0.10.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for tochka_py-0.0.5.tar.gz
Algorithm Hash digest
SHA256 0aff33080d0d176c5ed9cadd3cbb6441dcae877eb53fd2cbade52abb6dbc522b
MD5 6b18d33a903f1e13a7847c383d8b2a3c
BLAKE2b-256 6413f9cc42192053c265e47c78b5ccc0f540b3943ec2a1a225b7da9fb8a50450

See more details on using hashes here.

File details

Details for the file tochka_py-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: tochka_py-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 23.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.1 {"installer":{"name":"uv","version":"0.10.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for tochka_py-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 1ed53aeed02cf1a01f1ac40ca2064f94e275f8d03589f9512769346cb32e98be
MD5 d75f3542193f1d9e6aec2acf44a366d7
BLAKE2b-256 81c12996e14c260a22892befe7e5218b1ea9f5c608d70d909b54caf07bd23c2e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page