Faktury Web API

For automated invoicing in your systems

What is Faktury Web API?

The abbreviation API stands for Application Programming Interface. In simple terms, it is a set of rules, methods, and functions that allow two independent systems to communicate with each other. In this case, it connects Faktury Web with your system, such as an e-commerce store or website. The result is the creation of an invoice document in Faktury Web based on data coming from your system.

Faktury Web API in simple terms

Imagine two train stations connected by railway tracks. A freight train regularly departs from station A, carrying data to station B. There, the cargo is processed, and the train returns with information about the result. This is exactly how the Faktury Web API works.
Your application, such as an e-commerce store, represents station A. Faktury Web is station B, and the train with its tracks represents the API. Your system sends a request with the data you want to process. Faktury Web receives this data, processes it, and immediately sends back a response with the result. Everything happens automatically, without manual intervention.
The result is time savings, fewer errors, and smoother processes. Documents can be created, sent, or processed in the background exactly when you need them.
All you need to do is connect your system to the API, essentially building the "tracks" through which your data will flow securely and reliably between your system and Faktury Web. Your system controls the entire process. It decides when the train departs, what data it carries, and when it returns with the result.
API diagram sketch

How does it work?

In practice, it is communication between two servers via HTTP(S) requests. Your e-shop (client) sends an API request to the Faktury Web server, containing the required data, most commonly in JSON format.
The Faktury Web server receives the request, verifies its validity (for example, authentication and data correctness), then processes it and performs the requested operation, such as creating an invoice.
After processing, the server sends back a response containing information about the result of the operation. The response may include, for example, the identifier of the created document, its status, or an error message in case of failure.
The entire process runs automatically in real time and is controlled by your system, which decides when and what requests to send.

How can I connect Faktury Web API with my e-commerce store?

Implementing the API into your e-commerce store is a technical task. It must be done by a developer or a company that created your store, or someone familiar with how your system works. In most cases, this involves modifying the source code or installing and configuring a relevant module.
Typically, this is a custom implementation, as there is no universal solution. The implementation must be handled by a responsible person or company with access to the source code or system administration. Faktury Web cannot implement the API directly into your system; the implementation is always on your side.
We recommend contacting the author of your system or a qualified specialist. External companies specializing in such integrations can also assist you, for example goodeshop.cz.

What can be created via Faktury Web API?

Currently, the API allows you to create invoices and quotes. In addition to creating documents, the API also enables you to view them, download them, and retrieve information about their status.
Documents are created based on data sent from your system, which allows for flexibility and customization according to your needs.

What types of systems can use Faktury Web API?

Practically any system. The only requirement is that the system is connected to the internet. API integration is especially suitable for systems that need to automatically create accounting documents such as invoices or quotes.
These can include web applications, e-commerce platforms, CRM systems, POS systems, and more.

Where can I find the API technical documentation?

Detailed technical documentation with source code examples can be found on the Developer Documentation page.

Is Faktury Web API free?

Yes, you can use the Faktury Web API free of charge within your Faktury Web account. The API is not separately billed or specifically limited. Its usage is governed by the general terms and conditions of the service.