API Reference
Ta treść nie jest jeszcze dostępna w Twoim języku.
This page is generated at docs sync time from the SDK source tree. It replaces handwritten API reference pages so public signatures, return types, referenced models, exception classes, FA(3) exports, and XAdES helpers do not drift from the implementation.
Where the SDK maps to REST workflows, sections follow the tag structure of the official KSeF v2 OpenAPI reference. SDK-only surfaces such as client lifecycle, FA(3) builder helpers, and XAdES local signing stay in separate generated sections.
Sync variants generated from the async SDK tree are detected from the SDK generator header and marked with their canonical async source.
Authentication
Section titled “Authentication”| Page | Covers |
|---|---|
| Access | Authentication and bearer-token lifecycle methods. |
| Active authentication sessions | Authentication sessions opened through the KSeF auth API. |
Limits and restrictions
Section titled “Limits and restrictions”| Page | Covers |
|---|---|
| Limits and restrictions | Context, subject, and API rate-limit inspection and TEST overrides. |
Data encryption
Section titled “Data encryption”| Page | Covers |
|---|---|
| Public key certificates | Public encryption certificates published by KSeF. |
Invoices
Section titled “Invoices”| Page | Covers |
|---|---|
| Interactive sending | Opening, resuming, using, and closing online invoice sessions. |
| Batch sending | Preparing batch packages, opening batch sessions, uploading parts, and closing batches. |
| Status and UPO | Invoice-session history, session status, invoice status, failed invoices, and UPO downloads. |
| Invoice retrieval and exports | Invoice metadata queries, invoice downloads, export scheduling, and package retrieval. |
Permissions
Section titled “Permissions”| Page | Covers |
|---|---|
| Grant permissions | Grant person, entity, authorization, indirect, subunit, and EU entity permissions. |
| Revoke permissions | Revoke authorization and common KSeF permissions. |
| Permission search | Search granted permissions, roles, personal grants, and subordinate entities. |
| Permission operations | Check permission operation status and attachment permission state. |
Certificates
Section titled “Certificates”| Page | Covers |
|---|---|
| Certificates | KSeF certificate enrollment, retrieval, search, and revocation. |
KSeF tokens
Section titled “KSeF tokens”| Page | Covers |
|---|---|
| KSeF tokens | Generating, listing, checking, and revoking KSeF tokens. |
PEPPOL services
Section titled “PEPPOL services”| Page | Covers |
|---|---|
| PEPPOL services | PEPPOL provider lookup helpers. |
TEST data
Section titled “TEST data”| Page | Covers |
|---|---|
| TEST data | TEST-environment helpers for fixture subjects, people, permissions, attachments, and context blocks. |
SDK public surfaces
Section titled “SDK public surfaces”| Page | Covers |
|---|---|
| Client lifecycle and SDK entry points | SDK-specific root client construction, resource lifecycle, and top-level access to KSeF workflows. |
| FA(3) invoice builder | Public FA(3) facade and chainable builder methods. |
| XAdES helpers | Public certificate loading, TEST certificate generation, XML signing, and local signer helpers. |
Generated inventories
Section titled “Generated inventories”| Page | Covers |
|---|---|
| Public package exports | Generated root-level public imports exported from ksef2. |
| Errors | Generated public SDK exception classes and KSeF exception codes. |