Documentation – KSeF Service REST API + Automation Clients

Version: v1 / updated public scope

This document describes the publicly documented KSeF Service API and the operation of the sample automation clients: PowerShell (KSeFService.ps1) and Linux Bash (KSeFService.sh).

The currently communicated platform scope includes: sending FA(3) invoices, batch ZIP processing, invoice search/download, XML/PDF generation, correction XML generation, QR generation, status/UPO handling, JPK generation, CSV / custom export formats, permissions & roles management, and optional automation/webhook scenarios.

IMPORTANT!
The latest API documentation is available at https://ksefservice.pl/docs/swagger/.

Quick start

Authentication model

clientId – client GUID
login – account e-mail
password – panel / API password
api_env – TEST, PROD or DEMO

Typical integration flow

Generate XML from JSON or upload existing FA(3) XML
Optionally generate corrective XML
Send invoice XML or ZIP batch
Read processing/result payload
Store JSON log / session reference / invoice reference
Collect KSeF number and UPO when available
Optionally download XML or PDF later

Automation clients

Windows + PowerShell 5.1+
Linux + Bash + curl + zip
Internet access
Valid KSeF Service account and API access