Přeskočit na hlavní obsah

Pohoda

Pomocí tohoto modulu je možné stahovat data ze systému Pohoda (vyžaduje mServer)

Instalace

URL adresu vám sdělí váš poskytovatel cloudové Pohoda instalace. Zpřístupnění lokální instalace není zpravidla možné (výjimkou je, pokud máte k dispozici veřejnou IP adresu a Pohoda běží nepřetržitě). Uživatelské jméno a heslo odpovídá licenci, kterou máte pro tento účel k dispozici.

Budete potřebovat
  • IČ / IČO (Jedná se o IČ organizace na kterou se připojujeme)
  • Heslo (Heslo pro uživatele s přístupem na mServer)
  • Uživatelské jméno (Uživatelské jméno s přístupem na mServer)
  • URL adresa pohody (vč. portu) (URL adresa kde běží mServer)
  • Složka v adresáři firmy pro exporty souborů (V nastavení firmy je nutné vytvořit nový adresář, kam se budou ukládat exporty souborů (tisk PDF sestav))

Jak to funguje

Pro připojení k Pohodě se používá tzv. mServer. Jedná se o speciální program, která vytváří rozhraní pro příjem exportních a importních souborů pomocí kterých Pohoda komunikuje. Tento program je nutné mít nainstalovaný tam, kde běží Pohoda a mít k němu patřičnou licenci.

Pokud budete používat tiskové sestavy, budete vždy potřebovat znát ID tiskové sestavy a také budete potřebovat mít založený adresář, kam se tyto soubory budou ukládat (adresář musí být ve stejné složce jako je nastavení firmy z Globálního nastavení v rámci Pohody).


Funkce aplikace

Ověřit číslo objednávky

Ověří, zda zadané číslo objednávky existuje v Pohodě

Parametry aplikace

ID dokumentu: Pro tisk zadejte ID dokumentu nebo VS. Pozor, ID dokumentu není to stejné jako číslo dokladu.

Číslo objednávky

Výsledek volání aplikace

Ne: Pokud se nepodaří dohledat zásilku dle zadaného čísla

Ano: Pokud objednávka existuje

Ověřit objednávku dle ID

Ověří, zda zadané číslo objednávky existuje v Pohodě

Parametry aplikace

ID dokumentu: Pro tisk zadejte ID dokumentu nebo VS. Pozor, ID dokumentu není to stejné jako číslo dokladu.

Výsledek volání aplikace

Ne: Pokud se nepodaří dohledat zásilku dle zadaného čísla

Ano: Pokud objednávka existuje

Načtení parametru objednávky

Umožňuje načíst konkrétní parametr objednávky, který může obsahovat další informace, které souvisí s objednávkou (např. trackovací číslo apod.)

Parametry aplikace

Číslo objednávky

Název parametru

Výsledek volání aplikace

Ne: Pokud se nepodaří objednávku dohledat nebo pokud neexistuje zadaný parametr u objednávky

Načtení vlastnosti objednávky

Umožňuje načíst konkrétní parametr objednávky, který může obsahovat další informace, které souvisí s objednávkou (např. trackovací číslo apod.)

Parametry aplikace

Číslo objednávky

Název vlastnosti k načtení (cesta)

Výsledek volání aplikace

Ne: Pokud se nepodaří objednávku dohledat nebo pokud neexistuje zadaný parametr u objednávky

Načtení vlastnosti faktury

Umožňuje načíst konkrétní parametr faktury, který může obsahovat další informace, které souvisí s objednávkou (např. trackovací číslo apod.)

Parametry aplikace

Číslo faktury

Název vlastnosti k načtení (cesta)

Výsledek volání aplikace

Ne: Pokud se nepodaří objednávku dohledat nebo pokud neexistuje zadaný parametr u objednávky

Vytvořit PDF dokument

Na základě znalosti ID dokumentu nebo VS dokladu umožňuje vytvořit PDF kopii a tu nabídnout ke stáhnutí

Parametry aplikace

ID dokumentu: Pro tisk zadejte ID dokumentu nebo VS. Pozor, ID dokumentu není to stejné jako číslo dokladu.

Název agendy: Agenda určuje, jaké doklady budete exportovat. Nejčasteji se používá agenda "vydané faktury" ale lze použít i "přijaté faktury" nebo agendu pro objednávky. Příklad: vydane_faktury.

Číslo tiskové sestavy: Toto číslo sestavy (ID) je napsané přímo v nastavení Pohody u editací tiskových sestav.

Název souboru: Zadejte název souboru, tak jak se má vyexportovat. Soubor by měl mít vždy unikátní název. Příklad: Faktura_{{vs}}.pdf.

Cesta k souboru: Cesta k souboru kam se mají ukládat exporty (tisk PDF). Do cesty neuvádějte adresář, který jste nastavili nastavení aplikace Pohoda - bude doplněn automaticky. Příklad: C:\Pohoda\Moje firma\Dokumenty.

VS: Zadejte ID dokumentu nebo VS. Variabilní symbol má přednost při zadání obou hodnot. Příklad: 123456.

Výsledek volání aplikace

PDF nevytvořeno: Pokud se nepodaří objednávku dohledat nebo pokud neexistuje zadaný parametr u objednávky

PDF vytvořeno: Aplikace vrací další proměnné, které můžete dále ve scénáři používat:

  • {{[box].document}} Stav. Pokud je hodnotou "found" podařilo se dokument vytvořit a stáhnout. Příklad: found.
  • {{[box].documentpdf}} URL adresa PDF. Na této adrese lze stáhnout vygenerovaný PDF soubor. Příklad: https://cdn.msgok.net/....
Info

Co je {{[box]...}} ? Jedná se o zápis názvu proměnné. Protože každá proměnná má volitelný název, zobrazujeme univerzální [box]. V hranatých závorkách proto, abyste věděli že je nutné tuto část nahradit za reálný název proměnné. Pokud tedy je název vaší proměnné "app" a aplikace vrací {{[box].id}} pak je nutné ve scénáři použít {{app.id}}

Načíst existující PDF dokument

Na základě znalosti názvu dokumentu umožňuje stáhnout existující dokument

Parametry aplikace

Cesta k dokumentu

Výsledek volání aplikace

Ne: Pokud se nepodaří objednávku dohledat nebo pokud neexistuje zadaný parametr u objednávky

Načtení posledních změn u vystavených faktur

Umožňuje načíst změněné doklady, ve vybraném časovém období

Parametry aplikace

Období načítání dat

Výsledek volání aplikace

Ne: Pokud se nepodaří objednávku dohledat nebo pokud neexistuje zadaný parametr u objednávky

Načtení posledních změn u přijatých objednávek

Umožňuje načíst změněné doklady, ve vybraném časovém období

Parametry aplikace

Název vlastnosti k načtení (cesta)

Období načítání dat

Výsledek volání aplikace

Ne: Pokud se nepodaří objednávku dohledat nebo pokud neexistuje zadaný parametr u objednávky