Vyfakturuj.cz
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.
The module dialog fields that are displayed in bold (in the Boost.space Integrator scenario, not in this documentation article) are mandatory!
Connecting Vyfakturuj.cz to Boost.space Integrator
To connect your Vyfakturuj.cz account to Boost.space Integrator 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 Boost.space Integrator 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.
Invoices
Create an invoice
Creates a new invoice.
Connection
Establish a connection to your Vyfakturuj.cz account.
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
Text
Enter the text for the item.
Unit Price
Enter the price of the item.
Vat Rate
Enter VAT (in percent %)
Unit
Specify the item’s unit (pcs, kg,…)
Quantity
Enter the quantity of the item.
Get an Invoice
Retrieves an existing invoice details.
Connection
Establish a connection to your Vyfakturuj.cz account.
Invoice ID
Select or enter (map) the ID of the invoice you want to retrieve details for.
Search Invoices
Retrieves invoices based on filter settings.
Connection
Establish a connection to your Vyfakturuj.cz account.
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 Boost.space Integrator will return during one execution cycle.
Search Invoices
Retrieves an existing invoice details.
Connection
Establish a connection to your Vyfakturuj.cz account.
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 Boost.space Integrator will return during one execution cycle.
Make an API Call
Allows you to perform a custom API call.
Connection
Establish a connection to your Vyfakturuj.cz account.
URL
Enter a path relative to https://api.vyfakturuj.cz/2.0.For example: invoice.
For the list of available endpoints, refer to the Vyfakturuj.cz API Documentation.
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.
Example of Use – List Invoices
The following API call returns all invoices in your Vyfakturuj.cz account:
URL: /invoice
Method: GET
The result can be found in the module’s Output under Bundle > Body. In our example, 1 invoice were returned:
Legacy article, imported from the original Boost.space knowledge base (/knowledge-base/applications/commerce/vyfakturuj-cz/).
