Tento článek obsahuje výčet API proměnných, které můžete využít v URL webhooku, a informace o tom, kam vše správně zadat ve vašem účtu v systémech Vyfakturuj.cz či SimpleShop.
Obsah
Nastavení
Připravenou URL adresu webhooku můžete vložit globálně do nastavení svého účtu. V případě SimpleShopu můžete využít také možnost vložení přímo ke konkrétnímu produktu.
Globální nastavení
Ve svém účtu Vyfakturuj.cz nebo SimpleShop přejděte do Nastavení → Napojení → API.
URL adresu webhooku vložte do pole URL. URL adresa vložená v tomto nastavení bude zavolána při jakékoliv změně u dokladu jako je například editace a uložení dokladu, uhrazení, odeslání e-mailu s dokladem, ale i odeslání hromadného e-mailu.
Nastavení webhooku u produktu (pouze SimpleShop)
V SimpleShopu můžete adresu vložit také přímo ke konkrétnímu produktu. Nastavení naleznete v záložce Ostatní v úpravě daného produktu.
Adresu vložte do požadované kolonky Webhook po objednání nebo Webhook po uhrazení. SimpleShop zadanou URL adresu zavolá vždy v okamžiku dané akce – tedy po objednání nebo po uhrazení.
Seznam proměnných
V URL adrese webhooku je možné využívat následující proměnné.
POZN.: Sloupec označený jako Typ je určen pro vývojáře.
Obecné informace o dokladu
| Proměnná | Popis | Typ |
| id | ID dokumentu | int |
| type | Typ dokladu | int |
| number | Číslo dokumentu | string |
| order_number | ID objednávky | string255 |
| language | Jazyková mutace dokladu | string |
| text_before_items | Text před položkami faktury | string255 |
| text_invoice_footer | Text v patičce dokumentu | string255 |
| simpleshop_note | Poznámka SimpleShop | string255 |
| id_number_series | ID číselné řady | int |
| id_parent | ID nadřazeného dokumentu | int |
| id_tag | ID přiřazeného štítku | int |
| flags | Příznaky | int |
Informace o ceně a účetní údaje
| Proměnná | Popis | Typ |
| total | Celková částka k úhradě | double |
| total_without_vat | Celková částka k úhradě bez DPH | double |
| days_due | Splatnost uvedená počtem dní | int |
| currency | Měna (ISO 4217) | string3 |
| currency_domestic | Domácí měna | string3 |
| exchange_rate | Převodní kurz měny | double |
| VS | Variabilní symbol | string10 |
| KS | Konstantní symbol | string4 |
| SS | Specifický symbol | string10 |
| bank_account_number | Číslo bankovního účtu | string20 |
| bank_IBAN | Mezinárodní bankovní číslo (IBAN) | string60 |
| bank_BIC | Mezinárodní kód banky (SWIFT/BIC) | string20 |
| id_payment_method | ID platební metody | int |
| id_center | ID střediska | int |
| id_predkontace | ID předkontace | int |
| id_cleneniDPH | ID členění DPH | int |
| id_coupon | ID slevového kupónu | int |
| calculate_vat | Výpočet DPH | int |
| round_invoice | Zaokrouhlení dokumentu | int |
Informace o dodavateli
| Proměnná | Popis | Typ |
| supplier_IC | Dodavatel – IČO | string20 |
| supplier_DIC | Dodavatel – DIČ nebo IČ DPH | string20 |
| supplier_IDNUM3 | Dodavatel – Třetí identifikátor firmy (např. DIČ pro SK) | string20 |
| supplier_name | Dodavatel – název firmy | string100 |
| supplier_street | Dodavatel – ulice | string50 |
| supplier_city | Dodavatel – město | string50 |
| supplier_zip | Dodavatel – PSČ | int |
| supplier_country_code | Dodavatel – kód země (ISO 3166-2) | string2 |
| supplier_contact_name | Vystavil (kdo vystavil doklad) | string30 |
| supplier_contact_tel | Dodavatel – kontaktní telefon | string30 |
| supplier_contact_mail | Dodavatel – kontaktní e-mail | string30 |
| supplier_contact_web | Dodavatel – web | string100 |
| text_under_subscriber | Text pod dodavatelem | string255 |
Informace o odběrateli
| Proměnná | Popis | Typ |
| id_customer | ID kontaktu v adresáři | int |
| customer_IC | Odběratel – IČO | string20 |
| customer_DIC | Odběratel – DIČ nebo IČ DPH | string20 |
| customer_IDNUM3 | Odběratel – Třetí identifikátor firmy (např. DIČ pro SK) | string20 |
| customer_name | Odběratel – název firmy | string100 |
| customer_firstname | Odběratel – jméno | string100 |
| customer_lastname | Odběratel – příjmení | string100 |
| customer_street | Odběratel – ulice | string50 |
| customer_city | Odběratel – město | string50 |
| customer_zip | Odběratel – PSČ | int |
| customer_country_code | Odběratel – kód země (ISO 3166-2) | string2 |
| customer_tel | Odběratel – kontaktní telefon | string30 |
| text_under_customer | Text pod odběratelem | string255 |
Proměnná pro získání e-mailové adresy odběratele je ve tvaru {mail}. Tato proměnná je funkční pouze na úrovni produktu, nikoliv v globálním nastavení pro webhook.
Dodací údaje – odběratel
| Proměnná | Popis | Typ |
| customer_delivery_company | Dodací – název firmy | string100 |
| customer_delivery_firstname | Dodací – jméno | string100 |
| customer_delivery_lastname | Dodací- příjmení | string100 |
| customer_delivery_street | Dodací – ulice | string50 |
| customer_delivery_city | Dodací – město | string50 |
| customer_delivery_zip | Dodací – PSČ | int |
| customer_delivery_country_code | Dodací – kód země (ISO 3166-2) | string2 |
| customer_delivery_tel | Dodací – kontaktní telefon | string30 |
Hodnoty proměnných
Některé proměnné vrací číselnou hodnotu, ze které nelze odvodit, co číslo představuje. Tyto proměnné zobrazuje následující tabulka, která uvádí návratové hodnoty a jejich význam.
| Proměnná | Hodnoty | |
| type | 1 2 4 8 16 32 64 128 512 |
Faktura Zálohová faktura Proforma faktura Výzva k platbě Daňový doklad Opravný daňový doklad Příjmový doklad Opravný doklad Objednávka |
| language | cs sk en de it |
Česky Slovensky Anglicky Německy Italsky |
| flags | 1 2 4 8 16 32 64 256 1024 4096 65536 |
Dokument obsahuje DPH Uhrazeno Odesláno e-mailem zákazníkovi Doklad je stornován Odeslána e-mailem zákazníkovi upomínka Přeplatek Nedoplatek Doklad byl stažen účetním Čeká na odeslání přepravní společnosti Archivováno Doklad v OSS |
| calculate_vat | 1 2 3 4 5 6 |
Položky jsou uvedeny jako základ daně Položky mají koncovou cenu s DPH DPH je účtováno ve speciálním režimu DPH je v režimu přenesené daňové povinnosti v tuzemsku Neplátce DPH DPH je v režimu přenesené daňové povinnosti do zahraničí |
| round_invoice | 1 2 |
Nezaokrouhlovat Zaokrouhlit (haléřové vyrovnání) |
Výsledné číslo, které vrací proměnná flags, vzniká binárním součtem.
PŘÍKLAD: Pokud se jedná o doklad, který obsahuje DPH, je uhrazený a byl odeslán zákazníkovi, dostanete číslo 7.
