The Vyfakturuj.cz modules enable you to create, retrieve, search, send, mark as paid, or delete invoices and manage contacts in your Vyfakturuj.cz account.
Getting Started with Vyfakturuj.cz
Prerequisites
-
A Vyfakturuj.cz account — you can create one at app.vyfakturuj.cz/account/create.
![[Note]](../css/image/note.png)
|
Note |
|---|---|
|
The module dialog fields that are displayed in bold (in the {{Make}} scenario, not in this documentation article) are mandatory! |
To connect your Vyfakturuj.cz account to {{Make}} you need to obtain the API Key from your Vyfakturuj.cz account.
1. Log in to your Vyfakturuj.cz account.
2. Navigate to Nastavení > API.
3. Click the green Vygenerovat nový API klíč button.
4. Copy the generated API Key and store it in the safe place.
5. Go to {{Make}} and open the Vyfakturuj.cz module's Create a connection dialog.
6. Enter the email you have registered the Vyfakturuj.cz account with to the Email field and the API Key you have copied in step 4 to the respective field and click the Continue button to establish the connection.
The connection has been established. You can proceed with setting up the module.
Creates a new invoice.
|
Connection |
|||||||||||
|
ID Payment Method |
Select the payment method. |
||||||||||
|
Customer IC |
Enter the customer's IC (IČ, IČO) |
||||||||||
|
Customer DIC |
Enter the customer's IC (DIČ, IČO DPH) |
||||||||||
|
Customer Name |
Enter the customer's name. |
||||||||||
|
Customer Street |
Enter the customer's street. |
||||||||||
|
Customer City |
Enter the customer's city. |
||||||||||
|
Customer Zip |
Enter the customer's zip code. |
||||||||||
|
Customer Country |
Enter the customer's country. |
||||||||||
|
Items |
|
Retrieves an existing invoice details.
|
Connection |
|
|
Invoice ID |
Select or enter (map) the ID of the invoice you want to retrieve details for. |
Retrieves invoices based on filter settings.
|
Connection |
|
|
Search by |
Select whether to filter returned invoices using a field filter or a user-specified condition. |
|
Maximum number of returned invoices |
Set the maximum number of invoices {{Make}} will return during one execution cycle. |
Retrieves an existing invoice details.
|
Connection |
|
|
Search by |
Select whether to filter returned invoices using a field filter or a user-specified condition. |
|
Maximum number of returned invoices |
Set the maximum number of invoices {{Make}} will return during one execution cycle. |
Allows you to perform a custom API call.
|
Connection |
||||
|
URL |
Enter a path relative to
|
|||
|
Method |
Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. |
|||
|
Headers |
Enter the desired request headers. You don't have to add authorization headers; we added those for you. |
|||
|
Query String |
Enter the request query string. |
|||
|
Body |
Enter the body content for your API call. |
