Foxit eSign (Preview)

Foxit eSign je řešení elektronického podpisu, které umožňuje odesílat, podepisovat a spravovat dokumenty online – eliminuje potřebu tisku, skenování nebo korespondence. Nahrajte dokument, definujte pole podpisu a odešlete ho příjemcům pro rychlé a právně závazné eSignatury.

Tento konektor je dostupný v následujících produktech a oblastech:

Service	Class	Regions
Copilot Studio	Premium	Všechny oblasti Power Automate kromě následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD)
Logické aplikace	Standard	Všechny oblasti Logic Apps s výjimkou následujících: – Azure Government oblastí – Azure oblasti Čína - Ministerstvo obrany USA (DoD)
Power Apps	Premium	Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD)
Automatizace napájení	Premium	Všechny oblasti Power Automate kromě následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD)

Contact
Name	Podpora eSign foxit
URL	https://www.foxit.com
Email	api@foxit.com

Metadata konektoru
Vydavatel	Foxit Software Inc.
Internetová stránka	https://www.foxit.com/esign-pdf/
Zásady ochrany osobních údajů	https://www.foxit.com/company/privacy-policy.html
Kategorie	Produktivita; Obsah a soubory

Foxit eSign

Foxit eSign je podnikové řešení elektronického podpisu, které umožňuje firmám odesílat, podepisovat a spravovat právně závazné dokumenty zcela online – eliminuje potřebu tisku, skenování nebo korespondence. Nahrajte dokument, definujte pole podpisu a odešlete ho příjemcům pro rychlé a bezpečné eSignatury. Foxit eSign je plně kompatibilní s hlavními zákony o elektronickém podpisu, včetně ESIGN a UETA, používá šifrování k ochraně dokumentů při přenosu a neaktivních uložených místech a podporuje vícefaktorové ověřování, aby se zajistilo, že k dokumentům budou mít přístup a podepsat jenom autorizovaní podepisující osoby.

Konektor Foxit eSign pro Microsoft Power Automate umožňuje automatizovat celý pracovní postup podepisování dokumentů – od vytváření obálek a odesílání podpisů, ke sledování stavu, stahování dokončených dokumentů, správě šablon a aktivaci podřízených akcí při výskytu událostí obálky.

Publisher: Foxit Corporation

Předpoklady

Abyste mohli tento konektor použít, budete potřebovat:

Plán Microsoft Power Apps nebo Power Automate s vlastním konektorem nebo přístupem ke konektoru Premium
Účet Foxit eSign – vytvořte si ho tady
Přístup k rozhraní API povolený na vašem účtu Foxit eSign (viz získání přihlašovacích údajů níže)

Získání přihlašovacích údajů

Pokud ho ještě nemáte, vytvořte účet Foxit eSign.
Obraťte se na prodejní tým Foxit a požádejte o povolení přístupu k rozhraní API pro váš účet. Po schválení se ve vašem účtu aktivuje přístup k rozhraní API.
V Power Automate vyhledejte Foxit eSign v seznamu konektorů a vyberte Vytvořit připojení.
Budete přesměrováni na přihlašovací stránku Foxit eSign. Přihlaste se pomocí přihlašovacích údajů Foxit eSign a povolte připojení.
Po autorizaci je připojení připravené k použití ve vašich tocích.

Začínáme

Po vytvoření připojení můžete začít vytvářet toky pomocí konektoru Foxit eSign:

Triggery slouží k automatickému spuštění toku, když dojde k události obálky (např. když jsou podepsány všechny strany).
Pomocí akcí můžete vytvářet obálky, odesílat připomenutí podpisu, stahovat dokončené dokumenty, spravovat šablony a provádět další akce.
Zřetězte několik akcí – například vytvořte obálku ze šablony, počkejte na plně spuštěnou aktivační událost, stáhněte podepsaný dokument a uložte ho do SharePoint.

Podporované triggery

Trigger	Description
Při odeslání obálky	Aktivuje se při odeslání obálky příjemcům. Vyžaduje úroveň Webhooku nastavenou na Účet.
Při zobrazení obálky	Aktivuje se, když se příjemce otevře a zobrazí obálku.
Když je obálka podepsaná	Aktivuje se, když příjemce podepíše obálku.
Při zrušení obálky	Aktivuje se, když příjemce nebo odesílatel zruší obálku.
Při úplném spuštění obálky	Aktivuje se, když všichni příjemci podepsali a obálka se úplně dokončí.
Při odstranění obálky	Aktivuje se při odstranění obálky.

Podporované akce

Obálky

Action	Description
Vytvoření obálky z adresy URL	Vytvoří a odešle obálku pomocí veřejně přístupné adresy URL PDF.
Vytvoření obálky ze základny Base64	Vytvoří a odešle obálku pomocí dokumentu PDF s kódováním Base64.
Vytvoření obálky ze šablony	Vytvoří a odešle obálku z existující šablony Foxit eSign.
Získání podrobností o obálce	Načte úplné podrobnosti a aktuální stav obálky.
Získání ID obálek	Načte seznam ID obálek na základě kritérií filtru.
Odeslat připomenutí podpisu	Odešle oznámení s připomenutím čekajícími podepisujícími osoby obálky.
Stáhnout soubory obálek	Stáhne všechny podepsané dokumenty v obálce jako soubor ZIP.
Stáhnout jeden dokument PDF	Stáhne jeden dokument z obálky jako PDF.
Přesunutí obálek do koše	Přesune jednu nebo více obálek do koše.
Zrušit obálku	Zruší obálku a upozorní příjemce.
Odstranit obálky	Trvale odstraní jednu nebo více obálek.
Získání historie aktivit obálky	Načte celý protokol aktivit obálky.
Získání historie odstraněných obálek	Načte historii odstraněných obálek v účtu.

Šablony

Action	Description
Vytvoření šablony z adresy URL	Vytvoří opakovaně použitelnou podpisovou šablonu pomocí veřejně přístupné adresy URL PDF.
Vytvoření šablony z Base64	Vytvoří opakovaně použitelnou podpisovou šablonu pomocí dokumentu PDF s kódováním Base64.
Získání podrobností o šabloně	Načte úplné podrobnosti konkrétní šablony včetně definic polí.
Získání šablon podle ID šablon	Načte podrobnosti o jedné nebo více šablonách podle jejich ID.
Získání seznamu všech šablon	Načte všechny šablony dostupné v účtu.

Webhook

Action	Description
Zobrazit seznam všech kanálů webhooku	Vrátí seznam všech kanálů webhooku nakonfigurovaných v účtu.
Získání podrobností kanálu Webhooku	Načte podrobnosti o konkrétním kanálu webhooku.

E-mailové skupiny

Action	Description
Vytvoření e-mailové skupiny	Vytvoří novou e-mailovou skupinu pro použití jako příjemci v obálkách.
Získání podrobností o e-mailové skupině	Načte podrobnosti a členy e-mailové skupiny.

Zprávy

Action	Description
Stáhnout sestavu	Stáhne sestavu aktivit účtu ve formátu Microsoft Excel.

Známé problémy a omezení

Limit rychlosti: Rozhraní API eSign Foxit umožňuje až 4 000 požadavků za 5 minut na účet. Požadavky, které tento limit překročí, obdrží 429 Too Many Requests odpověď. Doporučujeme implementovat logiku opakování s exponenciálním reoffem ve vašich tocích, aby to bylo možné řádně zpracovat.
Omezení velikosti souboru: Maximální velikost souboru na dokument je 25 MB. Tento limit platí pro jednotlivé soubory, ne celkovou velikost obálky.
Automatické odhlášení odběru webhooku: Kvůli omezení v rozhraní API pro odstranění webhooku Foxit eSign (který používá metodu POST místo DELETE), Power Automate nemůže automaticky vyčistit odběry kanálu webhooku při odstranění nebo změně toku založeného na triggeru. Pomocí akce Seznam všech kanálů Webhooku identifikujte aktivní kanály a portál Foxit eSign k odebrání předplatných při vyřazení toku z provozu.
Při odeslání obálky – pouze úroveň účtu: Aktivační událost "Při odeslání obálky" se aktivuje pouze při nastavení úrovně Webhooku na Účet. Neaktivuje se pro obálky vytvořené na úrovni aplikace API . Při konfiguraci tohoto triggeru se ujistěte, že jste vybrali úroveň účtu.
Regionální dostupnost: Konektor je k dispozici pro účty severní Ameriky (NA1) i pro regiony EU. Při konfiguraci připojení vyberte příslušnou oblast serveru. Připojení k nesprávné oblasti způsobí selhání ověřování.
Velikost dokumentu Base64: Při použití obálky vytvořit z base64 nebo vytvořit šablonu z akcí Base64 musí řetězec kódovaný base64 odpovídat zdrojovému souboru, který není větší než 25 MB.

Support

Pokud potřebujete podporu pro vývojáře, obraťte se na tým Foxit eSign na adrese devsupport@foxitsoftware.com.

Pokud chcete odeslat případ podpory, navštivte https://kb.foxit.com/s/submit-a-casestránku .

Limity omezování

Name	Volání	Období obnovení
Volání rozhraní API na připojení	100	60 sekund

Akce

Odeslat připomenutí podpisu	Odešle oznámení s připomenutím čekajícími příjemci obálky a vyzve je k dokončení podepisování.
Odhlášení odběru triggeru Webhooku	Odstraní aktivní odběr kanálu webhooku podle ID kanálu. Pomocí této akce můžete vyčistit předplatná webhooků, která už nepotřebujete.
Odstranit obálky	Trvale odstraní jednu nebo více obálek.
Přesunutí obálek do koše	Přesune jednu nebo více obálek do koše. Obálky v koši se trvale neodstraní.
Stáhnout jeden dokument PDF	Stáhne jeden dokument z obálky jako soubor PDF.
Stáhnout sestavu	Stáhne sestavu aktivit obálky jako soubor Microsoft Excel. Pomocí filtrů můžete výsledky zúžit podle stavu, rozsahu dat, jména obálky, autora nebo podepisující osoby.
Stáhnout soubory obálek	Stáhne dokončené dokumenty z obálky jako soubor.
Vytvoření e-mailové skupiny	Vytvoří novou e-mailovou skupinu, kterou můžete použít k odesílání obálek více příjemcům najednou.
Vytvoření obálky z adresy URL	Vytvoří a odešle obálku pomocí veřejně přístupných adres URL PDF. Zadejte adresy URL dokumentu a podrobnosti o příjemci pro zahájení procesu podepisování.
Vytvoření obálky ze základny Base64	Vytvoří a odešle obálku pomocí dokumentu PDF s kódováním Base64.
Vytvoření obálky ze šablony	Vytvoří a odešle obálku pomocí existující šablony. Podrobnosti o příjemci je možné přizpůsobit.
Vytvoření šablony z adresy URL	Vytvoří novou šablonu pomocí veřejně přístupné adresy URL PDF.
Vytvoření šablony z Base64	Vytvoří novou šablonu pomocí řetězce PDF s kódováním Base64. Tuto možnost použijte, když je soubor PDF již k dispozici jako řetězec Base64 ve vašem toku, například z SharePoint souboru nebo OneDrive dokumentu.
Výpis všech kanálů Webhooku	Vrátí seznam všech kanálů webhooku nakonfigurovaných ve vašem účtu.
Zrušit obálku	Zruší odeslanou obálku. Příjemci už nebudou moct dokumenty podepsat.
Získání historie aktivit obálky	Načte úplný protokol aktivit obálky zobrazující všechny akce provedené příjemci a odesílatelem.
Získání historie odstraněných obálek	Načte historii obálek, které byly odstraněny nebo přesunuty do koše.
Získání ID obálky	Vrátí seznam ID obálek filtrovaných podle stavu. Tuto možnost použijte k vyhledání obálek v určitém stavu.
Získání podrobností kanálu Webhooku	Načte podrobnosti o konkrétním kanálu webhooku.
Získání podrobností o e-mailové skupině	Načte podrobnosti o existující e-mailové skupině.
Získání podrobností o obálce	Načte úplné podrobnosti obálky, včetně jejího stavu, příjemců a dokumentů.
Získání podrobností o šabloně	Načte úplné podrobnosti konkrétní šablony včetně polí a příjemců.
Získání seznamu všech šablon	Vrátí seznam všech šablon dostupných ve vašem účtu.
Získání šablon podle ID šablon	Načte podrobnosti o jedné nebo více šablonách podle jejich ID.

Odeslat připomenutí podpisu

ID operace:: SendSignatureReminder

Odešle oznámení s připomenutím čekajícími příjemci obálky a vyzve je k dokončení podepisování.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	folderId	True	integer	ID obálky.

Návraty

Name	Cesta	Typ	Description
Result	result	string	Určuje, jestli žádost proběhla úspěšně.
ID obálky	reminder sent	integer	ID obálky, pro kterou bylo připomenutí odesláno.

Odhlášení odběru triggeru Webhooku

ID operace:: DeleteTriggerWebhookChannel

Odstraní aktivní odběr kanálu webhooku podle ID kanálu. Pomocí této akce můžete vyčistit předplatná webhooků, která už nepotřebujete.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID kanálu	channelId	True	integer	ID kanálu webhooku, který chcete odstranit.

Odstranit obálky

ID operace:: DeleteEnvelopes

Trvale odstraní jednu nebo více obálek.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID složek	folderIds	True	array of integer	Pole ID obálek, na které se má jednat.

Návraty

Name	Cesta	Typ	Description
Result	result	string	Určuje, jestli operace proběhla úspěšně.

Přesunutí obálek do koše

ID operace:: MoveEnvelopestoRecycleBin

Přesune jednu nebo více obálek do koše. Obálky v koši se trvale neodstraní.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID složek	folderIds	True	array of integer	Pole ID obálek, na které se má jednat.

Návraty

Name	Cesta	Typ	Description
Result	result	string	Určuje, jestli operace proběhla úspěšně.

Stáhnout jeden dokument PDF

ID operace:: DownloadSingleDocumentPDF

Stáhne jeden dokument z obálky jako soubor PDF.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	folderId	True	string	Jedinečný identifikátor obálky obsahující dokument ke stažení.
Číslo dokumentu	docNumber	True	string	Index dokumentu, který chcete stáhnout, od 1.

Návraty

response: binary

Stáhnout sestavu

ID operace:: DownloadReport

Stáhne sestavu aktivit obálky jako soubor Microsoft Excel. Pomocí filtrů můžete výsledky zúžit podle stavu, rozsahu dat, jména obálky, autora nebo podepisující osoby.

Parametry

Name	Klíč	Typ	Description
obálkaStatus	status	string	Stavy složky, podle které vyfiltrujeme sestavu
Datum vytvoření od	creationDateFrom	string	Začátek rozsahu dat vytvoření Akceptovaný formát: RRRR-MM-DD.
Datum vytvoření do	creationDateTo	string	Konec rozsahu dat vytvoření Akceptovaný formát: RRRR-MM-DD.
Název obálky	folderName	string	Libovolná složka, která obsahuje tento řetězec.
Zahrnout pole	includeFields	string	Pokud chcete do sestavy zahrnout hodnoty pole obálky, nastavte hodnotu true. Výchozí hodnota je false.
Vytvořit e-mail	authorEmail	string	Vyfiltrujte sestavu tak, aby obsahovala jenom obálky vytvořené touto e-mailovou adresou autora.
E-mail podepisující osoby	signerEmail	string	Vyfiltrujte sestavu tak, aby obsahovala jenom obálky, ve kterých je tato e-mailová adresa podepisující.

Návraty

Soubor sestavy: binary

Stáhnout soubory obálek

ID operace:: DownloadEnvelopeFiles

Stáhne dokončené dokumenty z obálky jako soubor.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	folderId	True	string	Jedinečný identifikátor obálky, jejíž dokumenty chcete stáhnout.

Návraty

response: binary

Vytvoření e-mailové skupiny

ID operace:: CreateEmailGroup

Vytvoří novou e-mailovou skupinu, kterou můžete použít k odesílání obálek více příjemcům najednou.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název skupiny	emailGroupName	True	string	Název nové e-mailové skupiny
Popis skupiny	emailGroupDescription		string	Volitelný popis e-mailové skupiny.
Povolit rozšířené ověření e-mailu	allowAdvancedEmailValidation		boolean	Pokud je tato možnost povolená, foxit eSign před odesláním ověří, jestli jsou všechny e-mailové adresy ve skupině dostupné.
Křestní jméno	firstName	True	string	Jméno příjemce.
Příjmení	lastName	True	string	Příjmení příjemce.
Email	emailId	True	string	E-mailová adresa příjemce.

Návraty

Name	Cesta	Typ	Description
Result	result	string	Určuje, jestli žádost proběhla úspěšně.
Message	message	string	Potvrzovací zpráva o provedené akci.
ID skupiny	emailGroup.groupId	integer	Jedinečný identifikátor e-mailové skupiny. Toto ID použijte při odesílání obálek skupině.
Název skupiny	emailGroup.groupName	string	Název e-mailové skupiny.
Popis skupiny	emailGroup.groupDesc	string	Popis e-mailové skupiny
Datum vytvoření	emailGroup.dateCreated	integer	Datum vytvoření e-mailové skupiny v milisekundách unixu.
ID společnosti	emailGroup.companyId	integer	Firemní účet, do které patří tato e-mailová skupina.
Parties	emailGroup.parties	array of object	Seznam příjemců v e-mailové skupině
Křestní jméno	emailGroup.parties.firstName	string	Jméno příjemce.
Příjmení	emailGroup.parties.lastName	string	Příjmení příjemce.
Email	emailGroup.parties.emailId	string	E-mailová adresa příjemce.

Vytvoření obálky z adresy URL

ID operace:: CreateEnvelopefromURL

Vytvoří a odešle obálku pomocí veřejně přístupných adres URL PDF. Zadejte adresy URL dokumentu a podrobnosti o příjemci pro zahájení procesu podepisování.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název obálky	folderName	True	string	Název této obálky.
Typ vstupu	inputType		string	Určuje formát zdroje dokumentu. Nastavte na adresu URL pro zadání adres URL souborů nebo base64 pro poskytnutí obsahu souboru s kódováním Base64.
Adresy URL souborů	fileUrls	True	array of string	Pole veřejně přístupných adres URL odkazující na dokumenty, které se mají přidat do této obálky.
Názvy souborů	fileNames	True	array of string	Pole zobrazovaných názvů pro každý dokument ve stejném pořadí jako adresy URL souborů.
Křestní jméno	firstName	True	string	Jméno příjemce.
Příjmení	lastName	True	string	Příjmení příjemce.
E-mailová adresa	emailId	True	string	E-mailová adresa příjemce.
oprávnění	permission	True	string
Sequence	sequence	True	integer	Toto pole slouží k přiřazení pořadového čísla příjemci v seznamu stran příjemců. Pro každou stranu použijte jedinečná pořadová čísla začínající 1, například 1,2,3,4.... Pokud se v pracovním postupu podepisování zobrazí jedna osoba několikrát, přiřaďte pokaždé, když se příjemce opakuje, jinou posloupnost.
signerAuthLevels	signerAuthLevel		string	Úroveň ověřování, kterou bude podepisující člen využít pro účely ověření
Je zástupný symbol.	isPlaceholder		boolean	Toto pole slouží k zahájení party jako zástupného symbolu. Poznámka: 1. hodnota parametru firstName, lastName, emailId musí být prázdná pro tuto stranu. 2. Pokud chcete přidat zástupný symbol, musí se jeden příjemce znovu připojit s oprávněním "PARTY_ASSIGNER".
Role příjemce	partyRole		string	Pomocí tohoto pole můžete přiřadit roli zástupného symbolu.
Povolit změnu názvu	allowNameChange		string	Hodnota může mít hodnotu true nebo false. Tento parametr použijte, pokud chcete, aby podepisující proces před dokončením procesu podepisování aktualizoval křestní jméno a příjmení.
Pořadí pracovních postupů	workflowSequence		integer	Přiřaďte tomuto příjemci pořadové číslo pracovního postupu. Když je zapnuté pořadí přihlášení, dostanou příjemci pozvánku k podepisování ve vzestupném pořadí.
ID e-mailu hostitele	hostEmailId		string	E-mailová adresa správce In-Person.
Přístupový kód	userDefinedAccessCode		string	Parametr bude obsahovat přístupový kód, pokud je hodnota signerAuthLevel nastavená na uživatelem definovaný přístupový kód pro ověřování. Poznámka: 1. Kódy nerozlišují malá a velká písmena. 2. Systém tento kód neodesílá, takže tento kód musíte sdílet s podepisující osoby přímo. 3. Přístupový kód může obsahovat abecedy, čísla a následující speciální znaky: @,&,{,},%,(,),~,\|,!,+,^.
Party Is Email Group	partyIsEmailGroup		boolean	Tento parametr použijte při vytváření strany hromadně. Poznámka: Pokud je tento parametr true, firstName, lastName a emailId této strany bude ignorován.
ID e-mailové skupiny	emailGroupId		integer	Předejte e-mail s ID skupiny, které chcete použít k hromadnému vytvoření.
Hromadné jednotné přihlašování	allowSingleSignerInBulk		boolean	Pomocí tohoto parametru můžete povolit přihlášení e-mailové skupiny jenom jedné osobě.
Vytáčení kódu	dialingCode		string	Toto pole slouží k přiřazení kódů pro telefonické připojení země jako předpony mobilních čísel příjemci v seznamu stran příjemců.
Číslo mobilního zařízení	mobileNumber		string	Toto pole slouží k přiřazení mobilního čísla příjemci v seznamu stran příjemců.
Pole	Fields		object
Odeslat	sendNow		boolean	Pokud je tato možnost povolená, Foxit eSign okamžitě pošle jedinečný podpisový odkaz na e-mailovou adresu každého příjemce. Pokud chcete místo toho uložit obálku jako koncept, zakažte ji.
Vytvoření vložené podpisové relace	createEmbeddedSigningSession	True	boolean	Podpisový token relace se vygeneruje bez odeslání e-mailů příjemcům.
Vytvoření vložené podpisové relace pro všechny strany	createEmbeddedSigningSessionForAllParties		boolean	Pokud je nastavená hodnota true, vygeneruje se vložená podpisová adresa URL pro každého příjemce v obálce.
Zpracování textových značek	processTextTags	True	boolean	Hodnota může být true nebo false. Toto pole slouží k určení, jestli má Foxit eSign analyzovat dokumenty pro textové značky a převést je na pole Foxit eSign.
Zpracování polí Acro	processAcroFields	True	boolean	Toto pole slouží k určení, jestli má Foxit eSign parsovat dokumenty pro AcroFields a převést je na pole Foxit eSign.
Pořadí přihlášení	signInSequence		boolean	Toto pole slouží k určení, jestli příjemci podepíší dokumenty obálky v posloupnosti. Pokud je false, dostanou všichni příjemci e-mail s pozvánkou současně. Pokud ano, každý příjemce obdrží e-mail s pozvánkou po sobě po dokončení požadovaného úkolu, například podepsání dokumentů nebo vyplňování polí atd.
Povolení osobně	inPersonEnable		boolean	Toto pole slouží k zahájení procesu podepisování osobně, který se dá snadno dokončit na jakémkoli zařízení během několika minut a vyhne se podpisům založeným na e-mailu, pokud je to potřeba. Pokud je false, dostanou všichni příjemci e-mail s pozvánkou současně. Pokud je to pravda, správce osobně obdrží e-mail s pozvánkou, aby zahájil proces podepisování pro podepisující osobu.
Oprava stran příjemců	fixRecipientParties		boolean	Pokud ano, pak v vloženém zobrazení pro odesílání nelze změnit strany obálky, které jsou již přidány jako součást této žádosti.
Oprava dokumentů	fixDocuments		boolean	Pokud ano, pak ve vloženém odesílání nelze změnit dokumenty pro obálku, které jsou již přidány jako součást této žádosti.
Adresa URL pro úspěšné odeslání	sendSuccessUrl		string	Zadejte absolutní adresu URL cílové stránky, na kterou bude podepisující uživatel přesměrován po úspěšném odeslání složky v vloženém zobrazení pro odesílání.
Odeslat adresu URL chyby	sendErrorUrl		string	Zadejte absolutní adresu URL cílové stránky, na kterou se podepisující uživatel přesměruje, pokud při odesílání složky ve vloženém zobrazení pro odesílání dojde k chybě.
Vytvoření vložené relace odesílání	createEmbeddedSendingSession		boolean	Pokud je nastavena hodnota true, vygeneruje vložený token pro otevření dokumentu připravuje zobrazení Foxit eSign.
Id e-mailu vložených podepisujících podepisujících	embeddedSignersEmailIds		array of string	Pole e-mailových ID příjemců, pro které je potřeba vytvořit vloženou podpisovou relaci. ID e-mailu od příjemců, které byly přidány do seznamu stran.
Podepsat adresu URL úspěchu	signSuccessUrl		string	Zadejte absolutní adresu URL pro podepisující osoby, které budou přesměrovány po úspěšném přihlášení do vloženého podpisového zobrazení.
Adresa URL pro odmítnutí podpisu	signDeclineUrl		string	Zadejte absolutní adresu URL pro podepisující osoby, na které budou přesměrovány, pokud se odmítne přihlásit do vloženého zobrazení podepisování.
Podepsat pozdější adresu URL	signLaterUrl		string	Zadejte absolutní adresu URL pro podepisující osoby, na které budou přesměrovány, pokud se rozhodnete přihlásit se později v vloženém zobrazení podepisování.
Přihlašovací adresa URL chyby	signErrorUrl		string	Zadejte absolutní adresu URL pro podepisující osoby, na které se při podepisování dokumentu ve vloženém zobrazení podepisování přesměrují, na které dojde k chybě.
Povolit odesílání a vloženou podpisové relace	allowSendNowAndEmbeddedSigningSession		boolean	Pokud je nastavena hodnota true, Foxit eSign pošle každému příjemci jedinečný podpisový odkaz. To platí pouze v případě, že parametry sendNow a createEmbeddedSigningSession jsou pravdivé.
Rozšířené ověření e-mailu	allowAdvancedEmailValidation		boolean	Ověřte e-mailovou adresu stran, pokud je nastavená hodnota true.
Podepsat adresu URL úspěchu – Všechny strany	signSuccessUrlAllParties		boolean	Pokud je nastavená hodnota true, podepisující uživatel se po úspěšném podepsání přesměruje na adresu URL zadanou v signSuccessUrl. To platí pouze v případě, že sendNow je pravdivý.
ID šablony e-mailu	emailTemplateId		integer	Předejte ID e-mailové šablony pro odeslání e-mailových šablon kromě výchozích e-mailových šablon.
ID instrukce podepisující osoby	signerInstructionId		integer	Předejte ID instrukce pro odeslání pokynů podepisující osoby jiné než výchozí pokyny podepisující osoby.
ID instrukce potvrzení	confirmationInstructionId		string	Předejte ID instrukce potvrzení, aby se odeslaly jiné pokyny k potvrzení než výchozí pokyny pro potvrzení.
Barva motivu	themeColor		string	Zadejte hodnotu CSS a nastavte barvu motivu.
Vypršení platnosti relace	sessionExpire		boolean	Pokud chcete zahájit platnost vložené podpisové relace, nastavte hodnotu true.
Vypršení platnosti	expiry		integer	Vyžaduje se, pokud je relaceExpire pravdivá. Zadejte dobu trvání v milisekundách konce platnosti vložené podpisové relace.
Název závislého pole	dependentFieldName	True	string	Název pole, jehož viditelnost je řízena nadřazeným polem.
Název nadřazeného pole	parentFieldName	True	string	Název nadřazeného pole, jehož hodnota řídí viditelnost závislého pole. Podporované nadřazené typy polí: textové pole, zaškrtávací políčko, přepínač, rozevírací seznam.
Hodnota nadřazeného pole	parentFieldValue	True	string	Hodnota nadřazeného pole, které aktivuje zobrazení závislého pole. Pro zaškrtávací políčko a pole přepínačů použijte zaškrtnuté nebo nezaškrtnuté.
Možnosti	options	True	string	Další odpovídající možnosti pro nadřazená pole založená na textu Přijaté hodnoty: isblank, allowNull, contains.
Metadata	metadata		object	To by mělo být v páru klíč-hodnota. Je povoleno maximálně 1 000 párů klíč-hodnota.
E-mail odesílatele	senderEmail		string	zadejte do svého účtu e-mail jiného uživatele, který se použije k odeslání této složky dokumentů příjemcům.
Skrýt tlačítko Přidat mě	hideAddMeButton		boolean	Pokud je pravda, skryje tlačítko Přidat mě u stran příjemců ve vložené odesílající relaci.
Skrýt tlačítko Přidat nový	hideAddNewButton		boolean	Pokud ano, skryje tlačítko Přidat nový u stran příjemců ve vložené odesílající relaci.
Skrýt tlačítko Přidat skupinu	hideAddGroupButton		boolean	Pokud ano, skryje tlačítko Přidat skupinu u stran příjemců ve vložené odesílající relaci.
Skrýt jméno pole pro příjemce	hideFieldNameForRecipients		boolean	Skryjte názvy polí pro příjemce pro pole pro zadávání dat a upřesňující pole. (Kromě přepínače, zaškrtávacího políčka, obrázku a hypertextového odkazu)
Skrýt ohraničení zaškrtávacího políčka	hideCheckboxBorder		boolean	Ohraničení zaškrtávacího políčka bude v prováděných dokumentech skryté.
Skrýt možnost výběru podepisující osoby	hideSignerSelectOption		boolean	Pokud je pravda, skryje vstupní pole "Existující jméno/e-mail podepisující osoby" ve vložené odesílající relaci.
Skrýt akce podepisující osoby	hideSignerActions		boolean	Pokud je pravda, skryje se akce "upravit", "změnit" a "odebrat" u stran příjemců ve vložené odesílající relaci.
Skrýt jméno odesílatele	hideSenderName		boolean	Pokud ano, skryje se jméno odesílatele u stran příjemců ve vložené odesílající relaci.
Skrýt název složky	hideFolderName		boolean	Pokud je hodnota true, skryje se název složky při navigaci v obou vložených relací.
Skrýt název dokumentů	hideDocumentsName		boolean	Pokud ano, skryje název dokumentu v obou vložených relacích.
Skrýt odmítaný podpis	hideDeclineToSign		boolean	Pokud je pravda, skryje se možnost Odmítnout podepsat podepisující osoby.
Skrýt další akci	hideMoreAction		boolean	Pokud je true, skryje tlačítko Další akce při odesílání/podepisování relace. V případě "Odeslat nyní": true, to neukryje nic.
Skrýt tlačítko Odeslat	hideSendButton		boolean	Pokud ano, skryje se tlačítko Odeslat ve vložené odesílající relaci.
Skrýt další povinné pole	hideNextRequiredFieldbtn		boolean	Pokud je nastavená hodnota true, skryje navigační tlačítko, které přesune podepisující osoby do dalšího požadovaného pole.
Vyžaduje se obě vložená relace.	requiredBothEmbeddedSession		boolean	Pokud ano, vygeneruje vložené adresy URL pro odesílání a podepisování společně.
Heslo obálky	folderPassword		string	Toto heslo bude vyžadovat podepisující nebo autor k otevření digitálně podepsaného dokumentu. Pokud je parametr prázdný, nebude se k otevření digitálně podepsaného dokumentu vyžadovat žádné heslo.
Povolit krok za krokem	enableStepByStep		boolean	Pokud chcete povolit krok za krokem v vložené odesílající relaci.
Skrýt možnost Přidat strany	hideAddPartiesOption		boolean	Pokud ano, skryje možnost přidat strany v režimu Koncept a Vytvoření šablony.
Symbol vlastního podpisu	selfSign		boolean	Umožňuje integrované samoobslužné přihlašování prostřednictvím rozhraní API. Tento parametr platí pouze v případě, že je true parametr createEmbeddedSendingSession.
Adresa URL úspěchu podepisujícího sebe	selfSignerSuccessUrl		string	Zadejte absolutní adresu URL cílové stránky na webu nebo aplikaci, na kterou bude uživatel přesměrován po úspěšném odeslání složky ve vloženém zobrazení pro odesílání.

Návraty

Name	Cesta	Typ	Description
ID	folder.folderId	integer	Jedinečné ID nově vytvořené obálky. Tuto možnost použijte v následných akcích pro odkaz na tuto obálku.
Name	folder.folderName	string	Název nově vytvořené obálky.
Vlastní název	folder.folderCustomName	string	Vlastní název obálky.
Heslo	folder.folderPassword	string	Heslo pro přístup k obálce, pokud je nastavené.
ID tvůrce	folder.folderAuthorId	integer	Jedinečný identifikátor tvůrce obálky.
Jméno autora	folder.folderAuthorFirstName	string	Jméno tvůrce obálky.
Příjmení autora	folder.folderAuthorLastName	string	Příjmení tvůrce obálky.
E-mail pro tvůrce	folder.folderAuthorEmail	string	E-mailová adresa tvůrce obálky.
Role tvůrce	folder.folderAuthorRole	string	Role tvůrce obálky.
ID společnosti	folder.folderCompanyId	integer	Jedinečný identifikátor společnosti, která obálku vlastní.
Datum vytvoření	folder.folderCreationDate	integer	Datum vytvoření obálky (unixové časové razítko v milisekundách).
Datum odeslání	folder.folderSentDate	integer	Datum odeslání obálky (unixové časové razítko v milisekundách).
Stav	folder.folderStatus	string	Aktuální stav obálky.
Vlastní pole 1	folder.custom_field1	string	První vlastní pole metadat obálky.
Vlastní pole 2	folder.custom_field2	string	Druhé vlastní pole metadat obálky.
Metadata	folder.metadata	string	Vlastní metadata přidružená k obálce
ID dokumentů	folder.folderDocumentIds	array of integer	Seznam ID dokumentů obsažených v obálce
Documents	folder.documentsList	array of object	Seznam dokumentů v obálce.
ID dokumentu	folder.documentsList.documentId	integer	Jedinečný identifikátor dokumentu.
ID smlouvy	folder.documentsList.contractId	integer	Jedinečný identifikátor kontraktu.
ID společnosti	folder.documentsList.companyId	integer	Jedinečný identifikátor společnosti.
Vytvořeno kým	folder.documentsList.contractCreatedBy	integer	ID uživatele osoby, která smlouvu vytvořila.
Vytvořeno dne	folder.documentsList.contractCreatedOn	string	Datum a čas vytvoření smlouvy.
Typ smlouvy	folder.documentsList.contractType	string	Typ smlouvy.
Stav smlouvy	folder.documentsList.contractStatus	string	Aktuální stav smlouvy.
Upravitelný	folder.documentsList.editable	boolean	Určuje, jestli je položka upravitelná.
ID verze	folder.documentsList.contractVersionId	integer	Jedinečný identifikátor verze kontraktu.
Název verze	folder.documentsList.contractVersionName	string	Název verze smlouvy.
Popis verze	folder.documentsList.contractVersionDesc	string	Popis verze smlouvy.
Verze vytvořená uživatelem	folder.documentsList.versionCreatedby	integer	ID uživatele osoby, která tuto verzi vytvořila.
Verze vytvořená dne	folder.documentsList.versionCreatedOn	string	Datum a čas vytvoření této verze
Číslo verze	folder.documentsList.contractVersionNumber	integer	Číslo verze smlouvy.
Zdroj transakcí	folder.documentsList.contractTransactionSource	string	Zdrojový systém, který inicioval transakci kontraktu.
Příjemci	folder.folderRecipientParties	array of object	Seznam příjemců pro tuto obálku.
ID příjemce	folder.folderRecipientParties.partyId	integer	Jedinečný identifikátor příjemce.
ID příjemce	folder.folderRecipientParties.partyDetails.partyId	integer	Jedinečný identifikátor příjemce.
Křestní jméno	folder.folderRecipientParties.partyDetails.firstName	string	Jméno příjemce.
Příjmení	folder.folderRecipientParties.partyDetails.lastName	string	Příjmení příjemce.
E-mailová adresa	folder.folderRecipientParties.partyDetails.emailId	string	E-mailová adresa příjemce.
Zástupný text	folder.folderRecipientParties.partyDetails.placeholder	boolean	Určuje, jestli je tato strana zástupným příjemcem.
Address	folder.folderRecipientParties.partyDetails.address	string	Fyzická adresa příjemce.
Datum vytvoření	folder.folderRecipientParties.partyDetails.dateCreated	integer	Datum vytvoření záznamu (unixové časové razítko v milisekundách).
Odhlášení e-mailů	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Určuje, jestli se příjemce odhlásil z e-mailových oznámení.
Jedinečné ID příjemce	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Jedinečný systémový identifikátor tohoto příjemce.
Úroveň ověřování	folder.folderRecipientParties.partyDetails.authenticationLevel	string	Metoda ověřování požadovaná pro tohoto příjemce.
Datum aktualizace hesla	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	Datum poslední aktualizace hesla.
Aktualizovaný stav hesla	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Určuje, jestli se heslo aktualizovalo.
ID společnosti	folder.folderRecipientParties.partyDetails.companyId	integer	Jedinečný identifikátor společnosti.
Role uživatele	folder.folderRecipientParties.partyDetails.userRole	string	Role přiřazená uživateli.
Oddělení	folder.folderRecipientParties.partyDetails.department	string	Oddělení, do které uživatel patří.
Title	folder.folderRecipientParties.partyDetails.title	string	Pracovní pozice uživatele.
Aktivní	folder.folderRecipientParties.partyDetails.active	boolean	Určuje, jestli je uživatel nebo záznam aktivní.
Locale	folder.folderRecipientParties.partyDetails.requestLocale	string	Nastavení národního prostředí pro uživatele.
Sdílení s oddělením	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Určuje, jestli jsou obálky sdíleny napříč oddělením.
Vytáčení kódu	folder.folderRecipientParties.partyDetails.dialingCode	string	Mezinárodní číselný kód pro telefonní číslo.
Číslo mobilního zařízení	folder.folderRecipientParties.partyDetails.mobileNumber	string	Číslo mobilního telefonu.
Filtr stavu	folder.folderRecipientParties.partyDetails.docStatusFilter	string	Filtr pro stav dokumentu.
Filtr kalendářních dat	folder.folderRecipientParties.partyDetails.docDateFilter	string	Filtr pro datum dokumentu.
Zabezpečený přístup k polím	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Určuje, jestli má uživatel přístup k zabezpečeným polím.
Rozbalit boční panel	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Určuje, jestli je boční panel ve výchozím nastavení rozbalený.
Adv. Ověření e-mailu	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Určuje, jestli je povolené rozšířené ověření e-mailu.
ID správce	folder.folderRecipientParties.partyDetails.managerId	string	Jedinečný identifikátor správce uživatele.
Počet přihlášení	folder.folderRecipientParties.partyDetails.loginCount	integer	Počet přihlášení uživatele.
E-mail pro resetování hesla	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Určuje, jestli se má odeslat e-mail pro resetování hesla.
ID oddělení	folder.folderRecipientParties.partyDetails.departmentId	string	Jedinečný identifikátor oddělení.
Primární společnost	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	Primární společnost přidružená k uživateli.
Typ zařízení	folder.folderRecipientParties.partyDetails.deviceType	string	Typ použitého zařízení.
Token zařízení	folder.folderRecipientParties.partyDetails.deviceToken	string	Token nabízeného oznámení pro zařízení.
Popis subdodavatele	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Popis subdodavatele nebo externího podepisující osoby.
Organizace subdodavatelů	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	Název subdodavatele nebo externího podepisující osoby.
Datum přidání subdodavatele	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Datum přidání subdodavatele (unixové časové razítko v milisekundách).
Source	folder.folderRecipientParties.partyDetails.source	string	Zdrojový systém, ze kterého byl externí podepisující uživatel přidán.
Vytáčení kódu	folder.folderRecipientParties.dialingCode	string	Mezinárodní číselný kód pro telefonní číslo.
Číslo mobilního zařízení	folder.folderRecipientParties.mobileNumber	string	Číslo mobilního telefonu.
Typ podpisu	folder.folderRecipientParties.signerSignatureType	string	Typ podpisu, který podepisující znak použije.
Permissions	folder.folderRecipientParties.contractPermissions	string	Oprávnění udělená této straně smlouvy.
Podpisová objednávka	folder.folderRecipientParties.partySequence	integer	Pořadové číslo podpisové objednávky pro tohoto příjemce.
Pořadí pracovních postupů	folder.folderRecipientParties.workflowSignSequence	integer	Pořadové číslo podepisujícího pracovního postupu
ID obálky	folder.folderRecipientParties.envelopeId	integer	Jedinečný identifikátor obálky.
ID společnosti příjemce	folder.folderRecipientParties.partyCompanyId	integer	Jedinečný identifikátor společnosti přidružené k tomuto příjemci.
Režim sdílení	folder.folderRecipientParties.sharingMode	string	Režim sdílení pro tuto obálku.
Adresa URL pro přístup příjemce	folder.folderRecipientParties.folderAccessURL	string	Adresa URL, pomocí které může příjemce získat přístup k obálce a podepsat ji.
Režim zabezpečení	folder.folderRecipientParties.securityMode	string	Režim zabezpečení použitý na tuto obálku.
Komentáře	folder.folderRecipientParties.extraComments	string	Další komentáře, které jsou součástí obálky.
Povolit změnu názvu	folder.folderRecipientParties.allowNameChange	boolean	Určuje, jestli má příjemce povoleno aktualizovat své jméno.
Název aktualizován	folder.folderRecipientParties.signerNameUpdated	boolean	Určuje, jestli podepisující správce aktualizoval své jméno.
Úroveň ověřování podepisující osoby	folder.folderRecipientParties.signerAuthenticationLevel	string	Úroveň ověřování vyžadovaná pro podepisující osoby.
Přístupový kód	folder.folderRecipientParties.userDefinedAccessCode	string	Vlastní přístupový kód definovaný pro podepisující osoby.
ID podpisu	folder.folderRecipientParties.signatureId	string	Jedinečný identifikátor podpisu.
Role příjemce	folder.folderRecipientParties.partyRole	string	Role přiřazená tomuto příjemci v pracovním postupu podepisování.
Pole společnosti	folder.folderRecipientParties.companyFieldValue	string	Hodnota pole název společnosti v podpisu.
Pole nadpisu	folder.folderRecipientParties.titleFieldValue	string	Hodnota pole názvu v podpisu.
Důvod podepisování	folder.folderRecipientParties.reasonSigning	string	Důvod, proč příjemce dokument podepíše.
Přidáno platební pole	folder.folderRecipientParties.payFieldAdded	boolean	Určuje, jestli bylo přidáno pole platby.
Příjemce	folder.folderRecipientParties.payee	boolean	Určuje, jestli je příjemce příjemcem.
Opakovaná platba	folder.folderRecipientParties.recurringFieldExist	boolean	Určuje, jestli existuje opakující se platební pole.
Tisk a podepsání hotovo	folder.folderRecipientParties.printAndSignCompleted	boolean	Určuje, jestli je proces tisku a podpisu dokončený.
Paid	folder.folderRecipientParties.paid	boolean	Určuje, jestli byla platba dokončena.
Volitelné podepisující osoby povoleny	folder.folderRecipientParties.allowOptionalSigner	boolean	Určuje, jestli je tento příjemce volitelným podepisovačem.
Volitelné podepisující osoby	folder.folderRecipientParties.optionalSigners	array of integer	Seznam volitelných ID stran podepisující osoby pro tuto obálku.
Autor podpisové adresy URL	folder.folderAccessURLForAuthor	string	Adresa URL, pomocí které může odesílatel získat přístup k obálce.
Adresa URL přístupu konceptu	folder.draftFolderAccessURL	string	Adresa URL použitá pro přístup k konceptu obálky.
Podepisování na panelu	folder.boardRoomSign	boolean	Určuje, jestli je povolený režim podepisování tabulových místností.
Zahrnout logo	folder.includeLogo	boolean	Označuje, jestli je logo společnosti součástí e-mailů.
Barva pozadí tlačítka	folder.email_btnBgColor	string	Barva pozadí tlačítka e-mailu
Barva textu tlačítka	folder.email_btnTxtColor	string	Barva textu tlačítka e-mailu
Logo e-mailu	folder.emailTemplateLogo	string	Adresa URL loga použitá v e-mailové šabloně.
ID šablony e-mailu	folder.emailTemplateId	integer	Jedinečný identifikátor šablony e-mailu.
Záhlaví e-mailu	folder.emailHeader	string	Text záhlaví použitý v e-mailech s oznámeními.
Zápatí e-mailu	folder.emailFooter	string	Text zápatí použitý v e-mailech s oznámeními
Vyprázdnění naplánované	folder.purgeFlag	boolean	Určuje, jestli je obálka naplánována pro vyprázdnění.
Vyprázdnit počáteční datum	folder.purgeStartDate	string	Datum, od kterého je naplánováno vymazání.
Vyprázdnit koncové datum	folder.purgeEndDate	string	Datum, kdy je vyprázdnění naplánováno na dokončení.
ID hromadného odeslání	folder.bulkId	integer	Jedinečný identifikátor operace hromadného odeslání.
Vynucení pořadí podpisu	folder.enforceSignWorkflow	boolean	Určuje, jestli se příjemci musí přihlásit k definované sekvenci.
Aktuální krok	folder.currentWorkflowStep	integer	Aktuální krok v pracovním postupu podepisování.
Zdroj transakcí	folder.transactionSource	string	Zdrojový systém, který inicioval tuto transakci.
Upravitelný	folder.editable	boolean	Určuje, jestli je položka upravitelná.
podepisování In-Person	folder.inPersonSignable	boolean	Určuje, zda lze obálku podepsat osobně.
Přepsání připomenutí	folder.overrideAccountReminders	boolean	Určuje, jestli se přepíše nastavení připomenutí na úrovni účtu.
Přepsat delegování	folder.overrideAccountRecipientDelegation	boolean	Určuje, jestli se přepíše nastavení delegování na úrovni účtu.
Povolit delegování	folder.allowRecipientsToDelegate	boolean	Určuje, jestli mají příjemci povoleno delegovat podepisování.
ID	folder.envelopeId	integer	Jedinečný identifikátor obálky.
Name	folder.envelopeName	string	Název obálky.
ID původce	folder.envelopeOriginatorId	integer	Jedinečný identifikátor uživatele, který obálku vytvořil.
ID společnosti	folder.envelopeCompanyId	integer	Jedinečný identifikátor společnosti, která obálku vlastní.
Date	folder.envelopeDate	integer	Datum vytvoření obálky (unixové časové razítko v milisekundách).
Sdílené datum	folder.envelopeSharedDate	integer	Datum, kdy byla obálka sdílena (unixové časové razítko v milisekundách).
Stav	folder.envelopeStatus	string	Aktuální stav obálky.
ID kontraktů	folder.envelopeContractIds	array of integer	Seznam ID kontraktů přidružených k této obálce.
Oprávnění příjemce	folder.envelopePartyPermissions	array of object	Seznam oprávnění příjemců pro tuto obálku.
ID příjemce	folder.envelopePartyPermissions.partyId	integer	Jedinečný identifikátor příjemce.
ID příjemce	folder.envelopePartyPermissions.partyDetails.partyId	integer	Jedinečný identifikátor příjemce.
Křestní jméno	folder.envelopePartyPermissions.partyDetails.firstName	string	Jméno příjemce.
Příjmení	folder.envelopePartyPermissions.partyDetails.lastName	string	Příjmení příjemce.
E-mailová adresa	folder.envelopePartyPermissions.partyDetails.emailId	string	E-mailová adresa příjemce.
Zástupný text	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Určuje, jestli je tato strana zástupným příjemcem.
Address	folder.envelopePartyPermissions.partyDetails.address	string	Fyzická adresa příjemce.
Datum vytvoření	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	Datum vytvoření záznamu (unixové časové razítko v milisekundách).
Odhlášení e-mailů	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Určuje, jestli se příjemce odhlásil z e-mailových oznámení.
Jedinečné ID příjemce	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	Jedinečný systémový identifikátor tohoto příjemce.
Úroveň ověřování	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	Metoda ověřování požadovaná pro tohoto příjemce.
Datum aktualizace hesla	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	Datum poslední aktualizace hesla.
Aktualizovaný stav hesla	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Určuje, jestli se heslo aktualizovalo.
ID společnosti	folder.envelopePartyPermissions.partyDetails.companyId	integer	Jedinečný identifikátor společnosti.
Role uživatele	folder.envelopePartyPermissions.partyDetails.userRole	string	Role přiřazená uživateli.
Oddělení	folder.envelopePartyPermissions.partyDetails.department	string	Oddělení, do které uživatel patří.
Title	folder.envelopePartyPermissions.partyDetails.title	string	Pracovní pozice uživatele.
Aktivní	folder.envelopePartyPermissions.partyDetails.active	boolean	Určuje, jestli je uživatel nebo záznam aktivní.
Locale	folder.envelopePartyPermissions.partyDetails.requestLocale	string	Nastavení národního prostředí pro uživatele.
Sdílení s oddělením	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Určuje, jestli jsou obálky sdíleny napříč oddělením.
Vytáčení kódu	folder.envelopePartyPermissions.partyDetails.dialingCode	string	Mezinárodní číselný kód pro telefonní číslo.
Číslo mobilního zařízení	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	Číslo mobilního telefonu.
Filtr stavu	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	Filtr pro stav dokumentu.
Filtr kalendářních dat	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	Filtr pro datum dokumentu.
Zabezpečený přístup k polím	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Určuje, jestli má uživatel přístup k zabezpečeným polím.
Rozbalit boční panel	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Určuje, jestli je boční panel ve výchozím nastavení rozbalený.
Adv. Ověření e-mailu	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Určuje, jestli je povolené rozšířené ověření e-mailu.
ID správce	folder.envelopePartyPermissions.partyDetails.managerId	string	Jedinečný identifikátor správce uživatele.
Počet přihlášení	folder.envelopePartyPermissions.partyDetails.loginCount	integer	Počet přihlášení uživatele.
E-mail pro resetování hesla	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Určuje, jestli se má odeslat e-mail pro resetování hesla.
ID oddělení	folder.envelopePartyPermissions.partyDetails.departmentId	string	Jedinečný identifikátor oddělení.
Primární společnost	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	Primární společnost přidružená k uživateli.
Typ zařízení	folder.envelopePartyPermissions.partyDetails.deviceType	string	Typ použitého zařízení.
Token zařízení	folder.envelopePartyPermissions.partyDetails.deviceToken	string	Token nabízeného oznámení pro zařízení.
Popis subdodavatele	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	Popis subdodavatele nebo externího podepisující osoby.
Organizace subdodavatelů	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	Název subdodavatele nebo externího podepisující osoby.
Datum přidání subdodavatele	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	Datum přidání subdodavatele (unixové časové razítko v milisekundách).
Source	folder.envelopePartyPermissions.partyDetails.source	string	Zdrojový systém, ze kterého byl externí podepisující uživatel přidán.
Vytáčení kódu	folder.envelopePartyPermissions.dialingCode	string	Mezinárodní číselný kód pro telefonní číslo.
Číslo mobilního zařízení	folder.envelopePartyPermissions.mobileNumber	string	Číslo mobilního telefonu.
Typ podpisu	folder.envelopePartyPermissions.signerSignatureType	string	Typ podpisu, který podepisující znak použije.
Permissions	folder.envelopePartyPermissions.contractPermissions	string	Oprávnění udělená této straně smlouvy.
Podpisová objednávka	folder.envelopePartyPermissions.partySequence	integer	Pořadové číslo podpisové objednávky pro tohoto příjemce.
Pořadí pracovních postupů	folder.envelopePartyPermissions.workflowSignSequence	integer	Pořadové číslo podepisujícího pracovního postupu
ID obálky	folder.envelopePartyPermissions.envelopeId	integer	Jedinečný identifikátor obálky.
ID společnosti příjemce	folder.envelopePartyPermissions.partyCompanyId	integer	Jedinečný identifikátor společnosti přidružené k tomuto příjemci.
Režim sdílení	folder.envelopePartyPermissions.sharingMode	string	Režim sdílení pro tuto obálku.
Adresa URL pro přístup příjemce	folder.envelopePartyPermissions.folderAccessURL	string	Adresa URL, pomocí které může příjemce získat přístup k obálce a podepsat ji.
Režim zabezpečení	folder.envelopePartyPermissions.securityMode	string	Režim zabezpečení použitý na tuto obálku.
Komentáře	folder.envelopePartyPermissions.extraComments	string	Další komentáře, které jsou součástí obálky.
Povolit změnu názvu	folder.envelopePartyPermissions.allowNameChange	boolean	Určuje, jestli má příjemce povoleno aktualizovat své jméno.
Název aktualizován	folder.envelopePartyPermissions.signerNameUpdated	boolean	Určuje, jestli podepisující správce aktualizoval své jméno.
Úroveň ověřování podepisující osoby	folder.envelopePartyPermissions.signerAuthenticationLevel	string	Úroveň ověřování vyžadovaná pro podepisující osoby.
Přístupový kód	folder.envelopePartyPermissions.userDefinedAccessCode	string	Vlastní přístupový kód definovaný pro podepisující osoby.
ID podpisu	folder.envelopePartyPermissions.signatureId	string	Jedinečný identifikátor podpisu.
Role příjemce	folder.envelopePartyPermissions.partyRole	string	Role přiřazená tomuto příjemci v pracovním postupu podepisování.
Pole společnosti	folder.envelopePartyPermissions.companyFieldValue	string	Hodnota pole název společnosti v podpisu.
Pole nadpisu	folder.envelopePartyPermissions.titleFieldValue	string	Hodnota pole názvu v podpisu.
Důvod podepisování	folder.envelopePartyPermissions.reasonSigning	string	Důvod, proč příjemce dokument podepíše.
Přidáno platební pole	folder.envelopePartyPermissions.payFieldAdded	boolean	Určuje, jestli bylo přidáno pole platby.
Příjemce	folder.envelopePartyPermissions.payee	boolean	Určuje, jestli je příjemce příjemcem.
Opakovaná platba	folder.envelopePartyPermissions.recurringFieldExist	boolean	Určuje, jestli existuje opakující se platební pole.
Tisk a podepsání hotovo	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Určuje, jestli je proces tisku a podpisu dokončený.
Paid	folder.envelopePartyPermissions.paid	boolean	Určuje, jestli byla platba dokončena.
Úroveň ověřování	folder.envelopeAuthenticationLevel	string	Úroveň ověřování vyžadovaná pro obálku.
Hromadné jednotné přihlašování	folder.allowSingleSignerInBulk	boolean	Určuje, jestli je jednotné přihlašování povolené v režimu hromadného odesílání.
Pojmenování File-Based	folder.folderNameBasedOnFileNaming	boolean	Určuje, jestli je název složky založený na názvu souboru.
Název File-Based doc	folder.documentNameBasedOnFileNaming	boolean	Určuje, jestli je název dokumentu založený na názvu souboru.
Název File-Based certifikátu	folder.certificateNameBasedOnFileNaming	boolean	Určuje, jestli je název certifikátu založený na názvu souboru.
Pojmenování souborů pre-Exec	folder.enableFileNamingBeforeExecution	boolean	Určuje, jestli je před spuštěním dokumentu povolené pojmenování souboru.
Příjemce přidán	folder.payeeAddedd	boolean	Určuje, jestli byl příjemce přidán.
Self-Signing povoleno	folder.selfSignerEnabled	boolean	Označuje, jestli je povolený režim samoobslužného podepisování.
Notář povoleno	folder.notaryEnabled	boolean	Určuje, jestli je povolené podepisování notáře.
Omezená viditelnost	folder.limitedVisibilityFlag	boolean	Určuje, jestli je pro tuto obálku povolená omezená viditelnost.
Viditelnost po podepsání	folder.postSigningVisibility	boolean	Označuje, jestli je povolená viditelnost po podepsání.
Mokrý podpis	folder.wetSignatureEnabled	boolean	Určuje, jestli jsou povolené mokré podpisy.
Sloučit povoleno	folder.mergeEnabled	boolean	Určuje, jestli je povolené slučování dokumentu.
Vložené podpisové relace	embeddedSigningSessions	array of object	Seznam vložených podpisových relací, jeden na příjemce. Existuje pouze v případech, kdy je hodnota createEmbeddedSigningSession pravdivá.
E-mail podepisující osoby	embeddedSigningSessions.emailIdOfSigner	string	E-mailová adresa příjemce pro tuto vloženou podpisovou relaci.
Podpisový token	embeddedSigningSessions.embeddedToken	string	Jedinečný token pro vloženou podpisovou relaci tohoto příjemce.
Adresa URL podpisové relace	embeddedSigningSessions.embeddedSessionURL	string	Adresa URL pro otevření nebo vložení tohoto příjemce k podepsání dokumentu.
Vložený odesílající token	embeddedToken	string	Token pro vloženou odesílající relaci. Existuje pouze v případech, kdy je hodnota createEmbeddedSendingSession pravdivá.
Adresa URL relace pro odesílání	embeddedSessionURL	string	Adresa URL pro otevření nebo vložení obálky pro autora obálky k přípravě a odeslání obálky. Existuje pouze v případech, kdy je hodnota createEmbeddedSendingSession pravdivá.
Result	result	string	Výsledek operace.
Message	message	string	Zpráva popisující výsledek operace.

Vytvoření obálky ze základny Base64

ID operace:: CreateEnvelopefromBase64

Vytvoří a odešle obálku pomocí dokumentu PDF s kódováním Base64.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název obálky	folderName	True	string	Název této obálky.
Typ vstupu	inputType		string	Typ vstupu pro zdroj dokumentu. Byla opravena funkce Base64 pro tuto akci.
Řetězce souborů Base64	base64FileString	True	array of string	Pole dokumentů PDF s kódováním Base64, které se mají odeslat.
Názvy souborů	fileNames	True	array of string	Pole zobrazovaných názvů pro každý dokument ve stejném pořadí jako pole Řetězce souboru Base64.
Křestní jméno	firstName	True	string	Jméno příjemce.
Příjmení	lastName	True	string	Příjmení příjemce.
E-mailová adresa	emailId	True	string	E-mailová adresa příjemce.
oprávnění	permission	True	string
Sequence	sequence	True	integer	Toto pole slouží k přiřazení pořadového čísla příjemci v seznamu stran příjemců. Pro každou stranu použijte jedinečná pořadová čísla začínající 1, například 1,2,3,4.... Pokud se v pracovním postupu podepisování zobrazí jedna osoba několikrát, přiřaďte pokaždé, když se příjemce opakuje, jinou posloupnost.
signerAuthLevels	signerAuthLevel		string	Úroveň ověřování, kterou bude podepisující člen využít pro účely ověření
Je zástupný symbol.	isPlaceholder		boolean	Toto pole slouží k zahájení party jako zástupného symbolu. Poznámka: 1. hodnota parametru firstName, lastName, emailId musí být prázdná pro tuto stranu. 2. Pokud chcete přidat zástupný symbol, musí se jeden příjemce znovu připojit s oprávněním "PARTY_ASSIGNER".
Role příjemce	partyRole		string	Pomocí tohoto pole můžete přiřadit roli zástupného symbolu.
Povolit změnu názvu	allowNameChange		string	Hodnota může mít hodnotu true nebo false. Tento parametr použijte, pokud chcete, aby podepisující proces před dokončením procesu podepisování aktualizoval křestní jméno a příjmení.
Pořadí pracovních postupů	workflowSequence		integer	Přiřaďte tomuto příjemci pořadové číslo pracovního postupu. Když je zapnuté pořadí přihlášení, dostanou příjemci pozvánku k podepisování ve vzestupném pořadí.
ID e-mailu hostitele	hostEmailId		string	E-mailová adresa správce In-Person.
Přístupový kód	userDefinedAccessCode		string	Parametr bude obsahovat přístupový kód, pokud je hodnota signerAuthLevel nastavená na uživatelem definovaný přístupový kód pro ověřování. Poznámka: 1. Kódy nerozlišují malá a velká písmena. 2. Systém tento kód neodesílá, takže tento kód musíte sdílet s podepisující osoby přímo. 3. Přístupový kód může obsahovat abecedy, čísla a následující speciální znaky: @,&,{,},%,(,),~,\|,!,+,^.
Party Is Email Group	partyIsEmailGroup		boolean	Tento parametr použijte při vytváření strany hromadně. Poznámka: Pokud je tento parametr true, firstName, lastName a emailId této strany bude ignorován.
ID e-mailové skupiny	emailGroupId		integer	Předejte e-mail s ID skupiny, které chcete použít k hromadnému vytvoření.
Hromadné jednotné přihlašování	allowSingleSignerInBulk		boolean	Pomocí tohoto parametru můžete povolit přihlášení e-mailové skupiny jenom jedné osobě.
Vytáčení kódu	dialingCode		string	Toto pole slouží k přiřazení kódů pro telefonické připojení země jako předpony mobilních čísel příjemci v seznamu stran příjemců.
Číslo mobilního zařízení	mobileNumber		string	Toto pole slouží k přiřazení mobilního čísla příjemci v seznamu stran příjemců.
Pole	Fields		object
Odeslat	sendNow		boolean	Pokud je tato možnost povolená, Foxit eSign okamžitě pošle jedinečný podpisový odkaz na e-mailovou adresu každého příjemce. Pokud chcete místo toho uložit obálku jako koncept, zakažte ji.
Vytvoření vložené podpisové relace	createEmbeddedSigningSession	True	boolean	Podpisový token relace se vygeneruje bez odeslání e-mailů příjemcům.
Vytvoření vložené podpisové relace pro všechny strany	createEmbeddedSigningSessionForAllParties		boolean	Pokud je nastavená hodnota true, vygeneruje se vložená podpisová adresa URL pro každého příjemce v obálce.
Zpracování textových značek	processTextTags	True	boolean	Hodnota může být true nebo false. Toto pole slouží k určení, jestli má Foxit eSign analyzovat dokumenty pro textové značky a převést je na pole Foxit eSign.
Zpracování polí Acro	processAcroFields	True	boolean	Toto pole slouží k určení, jestli má Foxit eSign parsovat dokumenty pro AcroFields a převést je na pole Foxit eSign.
Pořadí přihlášení	signInSequence		boolean	Toto pole slouží k určení, jestli příjemci podepíší dokumenty obálky v posloupnosti. Pokud je false, dostanou všichni příjemci e-mail s pozvánkou současně. Pokud ano, každý příjemce obdrží e-mail s pozvánkou po sobě po dokončení požadovaného úkolu, například podepsání dokumentů nebo vyplňování polí atd.
Povolení osobně	inPersonEnable		boolean	Toto pole slouží k zahájení procesu podepisování osobně, který se dá snadno dokončit na jakémkoli zařízení během několika minut a vyhne se podpisům založeným na e-mailu, pokud je to potřeba. Pokud je false, dostanou všichni příjemci e-mail s pozvánkou současně. Pokud je to pravda, správce osobně obdrží e-mail s pozvánkou, aby zahájil proces podepisování pro podepisující osobu.
Oprava stran příjemců	fixRecipientParties		boolean	Pokud ano, pak v vloženém zobrazení pro odesílání nelze změnit strany obálky, které jsou již přidány jako součást této žádosti.
Oprava dokumentů	fixDocuments		boolean	Pokud ano, pak ve vloženém odesílání nelze změnit dokumenty pro obálku, které jsou již přidány jako součást této žádosti.
Adresa URL pro úspěšné odeslání	sendSuccessUrl		string	Zadejte absolutní adresu URL cílové stránky, na kterou bude podepisující uživatel přesměrován po úspěšném odeslání složky v vloženém zobrazení pro odesílání.
Odeslat adresu URL chyby	sendErrorUrl		string	Zadejte absolutní adresu URL cílové stránky, na kterou se podepisující uživatel přesměruje, pokud při odesílání složky ve vloženém zobrazení pro odesílání dojde k chybě.
Vytvoření vložené relace odesílání	createEmbeddedSendingSession		boolean	Pokud je nastavena hodnota true, vygeneruje vložený token pro otevření dokumentu připravuje zobrazení Foxit eSign.
Id e-mailu vložených podepisujících podepisujících	embeddedSignersEmailIds		array of string	Pole e-mailových ID příjemců, pro které je potřeba vytvořit vloženou podpisovou relaci. ID e-mailu od příjemců, které byly přidány do seznamu stran.
Podepsat adresu URL úspěchu	signSuccessUrl		string	Zadejte absolutní adresu URL pro podepisující osoby, které budou přesměrovány po úspěšném přihlášení do vloženého podpisového zobrazení.
Adresa URL pro odmítnutí podpisu	signDeclineUrl		string	Zadejte absolutní adresu URL pro podepisující osoby, na které budou přesměrovány, pokud se odmítne přihlásit do vloženého zobrazení podepisování.
Podepsat pozdější adresu URL	signLaterUrl		string	Zadejte absolutní adresu URL pro podepisující osoby, na které budou přesměrovány, pokud se rozhodnete přihlásit se později v vloženém zobrazení podepisování.
Přihlašovací adresa URL chyby	signErrorUrl		string	Zadejte absolutní adresu URL pro podepisující osoby, na které se při podepisování dokumentu ve vloženém zobrazení podepisování přesměrují, na které dojde k chybě.
Povolit odesílání a vloženou podpisové relace	allowSendNowAndEmbeddedSigningSession		boolean	Pokud je nastavena hodnota true, Foxit eSign pošle každému příjemci jedinečný podpisový odkaz. To platí pouze v případě, že parametry sendNow a createEmbeddedSigningSession jsou pravdivé.
Rozšířené ověření e-mailu	allowAdvancedEmailValidation		boolean	Ověřte e-mailovou adresu stran, pokud je nastavená hodnota true.
Podepsat adresu URL úspěchu – Všechny strany	signSuccessUrlAllParties		boolean	Pokud je nastavená hodnota true, podepisující uživatel se po úspěšném podepsání přesměruje na adresu URL zadanou v signSuccessUrl. To platí pouze v případě, že sendNow je pravdivý.
ID šablony e-mailu	emailTemplateId		integer	Předejte ID e-mailové šablony pro odeslání e-mailových šablon kromě výchozích e-mailových šablon.
ID instrukce podepisující osoby	signerInstructionId		integer	Předejte ID instrukce pro odeslání pokynů podepisující osoby jiné než výchozí pokyny podepisující osoby.
ID instrukce potvrzení	confirmationInstructionId		string	Předejte ID instrukce potvrzení, aby se odeslaly jiné pokyny k potvrzení než výchozí pokyny pro potvrzení.
Barva motivu	themeColor		string	Zadejte hodnotu CSS a nastavte barvu motivu.
Vypršení platnosti relace	sessionExpire		boolean	Pokud chcete zahájit platnost vložené podpisové relace, nastavte hodnotu true.
Vypršení platnosti	expiry		integer	Vyžaduje se, pokud je relaceExpire pravdivá. Zadejte dobu trvání v milisekundách konce platnosti vložené podpisové relace.
Název závislého pole	dependentFieldName	True	string	Název pole, jehož viditelnost je řízena nadřazeným polem.
Název nadřazeného pole	parentFieldName	True	string	Název nadřazeného pole, jehož hodnota řídí viditelnost závislého pole. Podporované nadřazené typy polí: textové pole, zaškrtávací políčko, přepínač, rozevírací seznam.
Hodnota nadřazeného pole	parentFieldValue	True	string	Hodnota nadřazeného pole, které aktivuje zobrazení závislého pole. Pro zaškrtávací políčko a pole přepínačů použijte zaškrtnuté nebo nezaškrtnuté.
Možnosti	options	True	string	Další odpovídající možnosti pro nadřazená pole založená na textu Přijaté hodnoty: isblank, allowNull, contains.
Metadata	metadata		object	To by mělo být v páru klíč-hodnota. Je povoleno maximálně 1 000 párů klíč-hodnota.
E-mail odesílatele	senderEmail		string	zadejte do svého účtu e-mail jiného uživatele, který se použije k odeslání této složky dokumentů příjemcům.
Skrýt tlačítko Přidat mě	hideAddMeButton		boolean	Pokud je pravda, skryje tlačítko Přidat mě u stran příjemců ve vložené odesílající relaci.
Skrýt tlačítko Přidat nový	hideAddNewButton		boolean	Pokud ano, skryje tlačítko Přidat nový u stran příjemců ve vložené odesílající relaci.
Skrýt tlačítko Přidat skupinu	hideAddGroupButton		boolean	Pokud ano, skryje tlačítko Přidat skupinu u stran příjemců ve vložené odesílající relaci.
Skrýt jméno pole pro příjemce	hideFieldNameForRecipients		boolean	Skryjte názvy polí pro příjemce pro pole pro zadávání dat a upřesňující pole. (Kromě přepínače, zaškrtávacího políčka, obrázku a hypertextového odkazu)
Skrýt ohraničení zaškrtávacího políčka	hideCheckboxBorder		boolean	Ohraničení zaškrtávacího políčka bude v prováděných dokumentech skryté.
Skrýt možnost výběru podepisující osoby	hideSignerSelectOption		boolean	Pokud je pravda, skryje vstupní pole "Existující jméno/e-mail podepisující osoby" ve vložené odesílající relaci.
Skrýt akce podepisující osoby	hideSignerActions		boolean	Pokud je pravda, skryje se akce "upravit", "změnit" a "odebrat" u stran příjemců ve vložené odesílající relaci.
Skrýt jméno odesílatele	hideSenderName		boolean	Pokud ano, skryje se jméno odesílatele u stran příjemců ve vložené odesílající relaci.
Skrýt název složky	hideFolderName		boolean	Pokud je hodnota true, skryje se název složky při navigaci v obou vložených relací.
Skrýt název dokumentů	hideDocumentsName		boolean	Pokud ano, skryje název dokumentu v obou vložených relacích.
Skrýt odmítaný podpis	hideDeclineToSign		boolean	Pokud je pravda, skryje se možnost Odmítnout podepsat podepisující osoby.
Skrýt další akci	hideMoreAction		boolean	Pokud je true, skryje tlačítko Další akce při odesílání/podepisování relace. V případě "Odeslat nyní": true, to neukryje nic.
Skrýt tlačítko Odeslat	hideSendButton		boolean	Pokud ano, skryje se tlačítko Odeslat ve vložené odesílající relaci.
Skrýt další povinné pole	hideNextRequiredFieldbtn		boolean	Pokud je nastavená hodnota true, skryje navigační tlačítko, které přesune podepisující osoby do dalšího požadovaného pole.
Požadováno obě vložené relace	requiredBothEmbeddedSession		boolean	Pokud ano, vygeneruje vložené adresy URL pro odesílání a podepisování společně.
Heslo obálky	folderPassword		string	Toto heslo bude vyžadovat podepisující nebo autor k otevření digitálně podepsaného dokumentu. Pokud je parametr prázdný, nebude se k otevření digitálně podepsaného dokumentu vyžadovat žádné heslo.
Povolit krok za krokem	enableStepByStep		boolean	Pokud chcete povolit krok za krokem v vložené odesílající relaci.
Skrýt možnost Přidat strany	hideAddPartiesOption		boolean	Pokud ano, skryje možnost přidat strany v režimu Koncept a Vytvoření šablony.
Symbol vlastního podpisu	selfSign		boolean	Umožňuje integrované samoobslužné přihlašování prostřednictvím rozhraní API. Tento parametr platí pouze v případě, že je true parametr createEmbeddedSendingSession.
Adresa URL úspěchu podepisujícího sebe	selfSignerSuccessUrl		string	Zadejte absolutní adresu URL cílové stránky na webu nebo aplikaci, na kterou bude uživatel přesměrován po úspěšném odeslání složky ve vloženém zobrazení pro odesílání.

Návraty

Name	Cesta	Typ	Description
ID	folder.folderId	integer	Jedinečné ID nově vytvořené obálky. Tuto možnost použijte v následných akcích pro odkaz na tuto obálku.
Name	folder.folderName	string	Název nově vytvořené obálky.
Vlastní název	folder.folderCustomName	string	Vlastní název obálky.
Heslo	folder.folderPassword	string	Heslo pro přístup k obálce, pokud je nastavené.
ID tvůrce	folder.folderAuthorId	integer	Jedinečný identifikátor tvůrce obálky.
Jméno autora	folder.folderAuthorFirstName	string	Jméno tvůrce obálky.
Příjmení autora	folder.folderAuthorLastName	string	Příjmení tvůrce obálky.
E-mail pro tvůrce	folder.folderAuthorEmail	string	E-mailová adresa tvůrce obálky.
Role tvůrce	folder.folderAuthorRole	string	Role tvůrce obálky.
ID společnosti	folder.folderCompanyId	integer	Jedinečný identifikátor společnosti, která obálku vlastní.
Datum vytvoření	folder.folderCreationDate	integer	Datum vytvoření obálky (unixové časové razítko v milisekundách).
Datum odeslání	folder.folderSentDate	integer	Datum odeslání obálky (unixové časové razítko v milisekundách).
Stav	folder.folderStatus	string	Aktuální stav obálky.
Vlastní pole 1	folder.custom_field1	string	První vlastní pole metadat obálky.
Vlastní pole 2	folder.custom_field2	string	Druhé vlastní pole metadat obálky.
Metadata	folder.metadata	string	Vlastní metadata přidružená k obálce
ID dokumentů	folder.folderDocumentIds	array of integer	Seznam ID dokumentů obsažených v obálce
Documents	folder.documentsList	array of object	Seznam dokumentů v obálce.
ID dokumentu	folder.documentsList.documentId	integer	Jedinečný identifikátor dokumentu.
ID smlouvy	folder.documentsList.contractId	integer	Jedinečný identifikátor kontraktu.
ID společnosti	folder.documentsList.companyId	integer	Jedinečný identifikátor společnosti.
Vytvořeno kým	folder.documentsList.contractCreatedBy	integer	ID uživatele osoby, která smlouvu vytvořila.
Vytvořeno dne	folder.documentsList.contractCreatedOn	string	Datum a čas vytvoření smlouvy.
Typ smlouvy	folder.documentsList.contractType	string	Typ smlouvy.
Stav smlouvy	folder.documentsList.contractStatus	string	Aktuální stav smlouvy.
Upravitelný	folder.documentsList.editable	boolean	Určuje, jestli je položka upravitelná.
ID verze	folder.documentsList.contractVersionId	integer	Jedinečný identifikátor verze kontraktu.
Název verze	folder.documentsList.contractVersionName	string	Název verze smlouvy.
Popis verze	folder.documentsList.contractVersionDesc	string	Popis verze smlouvy.
Verze vytvořená uživatelem	folder.documentsList.versionCreatedby	integer	ID uživatele osoby, která tuto verzi vytvořila.
Verze vytvořená dne	folder.documentsList.versionCreatedOn	string	Datum a čas vytvoření této verze
Číslo verze	folder.documentsList.contractVersionNumber	integer	Číslo verze smlouvy.
Zdroj transakcí	folder.documentsList.contractTransactionSource	string	Zdrojový systém, který inicioval transakci kontraktu.
Příjemci	folder.folderRecipientParties	array of object	Seznam příjemců pro tuto obálku.
ID příjemce	folder.folderRecipientParties.partyId	integer	Jedinečný identifikátor příjemce.
ID příjemce	folder.folderRecipientParties.partyDetails.partyId	integer	Jedinečný identifikátor příjemce.
Křestní jméno	folder.folderRecipientParties.partyDetails.firstName	string	Jméno příjemce.
Příjmení	folder.folderRecipientParties.partyDetails.lastName	string	Příjmení příjemce.
E-mailová adresa	folder.folderRecipientParties.partyDetails.emailId	string	E-mailová adresa příjemce.
Zástupný text	folder.folderRecipientParties.partyDetails.placeholder	boolean	Určuje, jestli je tato strana zástupným příjemcem.
Address	folder.folderRecipientParties.partyDetails.address	string	Fyzická adresa příjemce.
Datum vytvoření	folder.folderRecipientParties.partyDetails.dateCreated	integer	Datum vytvoření záznamu (unixové časové razítko v milisekundách).
Odhlášení e-mailů	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Určuje, jestli se příjemce odhlásil z e-mailových oznámení.
Jedinečné ID příjemce	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Jedinečný systémový identifikátor tohoto příjemce.
Úroveň ověřování	folder.folderRecipientParties.partyDetails.authenticationLevel	string	Metoda ověřování požadovaná pro tohoto příjemce.
Datum aktualizace hesla	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	Datum poslední aktualizace hesla.
Aktualizovaný stav hesla	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Určuje, jestli se heslo aktualizovalo.
ID společnosti	folder.folderRecipientParties.partyDetails.companyId	integer	Jedinečný identifikátor společnosti.
Role uživatele	folder.folderRecipientParties.partyDetails.userRole	string	Role přiřazená uživateli.
Oddělení	folder.folderRecipientParties.partyDetails.department	string	Oddělení, do které uživatel patří.
Title	folder.folderRecipientParties.partyDetails.title	string	Pracovní pozice uživatele.
Aktivní	folder.folderRecipientParties.partyDetails.active	boolean	Určuje, jestli je uživatel nebo záznam aktivní.
Locale	folder.folderRecipientParties.partyDetails.requestLocale	string	Nastavení národního prostředí pro uživatele.
Sdílení s oddělením	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Určuje, jestli jsou obálky sdíleny napříč oddělením.
Vytáčení kódu	folder.folderRecipientParties.partyDetails.dialingCode	string	Mezinárodní číselný kód pro telefonní číslo.
Číslo mobilního zařízení	folder.folderRecipientParties.partyDetails.mobileNumber	string	Číslo mobilního telefonu.
Filtr stavu	folder.folderRecipientParties.partyDetails.docStatusFilter	string	Filtr pro stav dokumentu.
Filtr kalendářních dat	folder.folderRecipientParties.partyDetails.docDateFilter	string	Filtr pro datum dokumentu.
Zabezpečený přístup k polím	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Určuje, jestli má uživatel přístup k zabezpečeným polím.
Rozbalit boční panel	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Určuje, jestli je boční panel ve výchozím nastavení rozbalený.
Adv. Ověření e-mailu	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Určuje, jestli je povolené rozšířené ověření e-mailu.
ID správce	folder.folderRecipientParties.partyDetails.managerId	string	Jedinečný identifikátor správce uživatele.
Počet přihlášení	folder.folderRecipientParties.partyDetails.loginCount	integer	Počet přihlášení uživatele.
E-mail pro resetování hesla	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Určuje, jestli se má odeslat e-mail pro resetování hesla.
ID oddělení	folder.folderRecipientParties.partyDetails.departmentId	string	Jedinečný identifikátor oddělení.
Primární společnost	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	Primární společnost přidružená k uživateli.
Typ zařízení	folder.folderRecipientParties.partyDetails.deviceType	string	Typ použitého zařízení.
Token zařízení	folder.folderRecipientParties.partyDetails.deviceToken	string	Token nabízeného oznámení pro zařízení.
Popis subdodavatele	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Popis subdodavatele nebo externího podepisující osoby.
Organizace subdodavatelů	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	Název subdodavatele nebo externího podepisující osoby.
Datum přidání subdodavatele	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Datum přidání subdodavatele (unixové časové razítko v milisekundách).
Source	folder.folderRecipientParties.partyDetails.source	string	Zdrojový systém, ze kterého byl externí podepisující uživatel přidán.
Vytáčení kódu	folder.folderRecipientParties.dialingCode	string	Mezinárodní číselný kód pro telefonní číslo.
Číslo mobilního zařízení	folder.folderRecipientParties.mobileNumber	string	Číslo mobilního telefonu.
Typ podpisu	folder.folderRecipientParties.signerSignatureType	string	Typ podpisu, který podepisující znak použije.
Permissions	folder.folderRecipientParties.contractPermissions	string	Oprávnění udělená této straně smlouvy.
Podpisová objednávka	folder.folderRecipientParties.partySequence	integer	Pořadové číslo podpisové objednávky pro tohoto příjemce.
Pořadí pracovních postupů	folder.folderRecipientParties.workflowSignSequence	integer	Pořadové číslo podepisujícího pracovního postupu
ID obálky	folder.folderRecipientParties.envelopeId	integer	Jedinečný identifikátor obálky.
ID společnosti příjemce	folder.folderRecipientParties.partyCompanyId	integer	Jedinečný identifikátor společnosti přidružené k tomuto příjemci.
Režim sdílení	folder.folderRecipientParties.sharingMode	string	Režim sdílení pro tuto obálku.
Adresa URL pro přístup příjemce	folder.folderRecipientParties.folderAccessURL	string	Adresa URL, pomocí které může příjemce získat přístup k obálce a podepsat ji.
Režim zabezpečení	folder.folderRecipientParties.securityMode	string	Režim zabezpečení použitý na tuto obálku.
Komentáře	folder.folderRecipientParties.extraComments	string	Další komentáře, které jsou součástí obálky.
Povolit změnu názvu	folder.folderRecipientParties.allowNameChange	boolean	Určuje, jestli má příjemce povoleno aktualizovat své jméno.
Název aktualizován	folder.folderRecipientParties.signerNameUpdated	boolean	Určuje, jestli podepisující správce aktualizoval své jméno.
Úroveň ověřování podepisující osoby	folder.folderRecipientParties.signerAuthenticationLevel	string	Úroveň ověřování vyžadovaná pro podepisující osoby.
Přístupový kód	folder.folderRecipientParties.userDefinedAccessCode	string	Vlastní přístupový kód definovaný pro podepisující osoby.
ID podpisu	folder.folderRecipientParties.signatureId	string	Jedinečný identifikátor podpisu.
Role příjemce	folder.folderRecipientParties.partyRole	string	Role přiřazená tomuto příjemci v pracovním postupu podepisování.
Pole společnosti	folder.folderRecipientParties.companyFieldValue	string	Hodnota pole název společnosti v podpisu.
Pole nadpisu	folder.folderRecipientParties.titleFieldValue	string	Hodnota pole názvu v podpisu.
Důvod podepisování	folder.folderRecipientParties.reasonSigning	string	Důvod, proč příjemce dokument podepíše.
Přidáno platební pole	folder.folderRecipientParties.payFieldAdded	boolean	Určuje, jestli bylo přidáno pole platby.
Příjemce	folder.folderRecipientParties.payee	boolean	Určuje, jestli je příjemce příjemcem.
Opakovaná platba	folder.folderRecipientParties.recurringFieldExist	boolean	Určuje, jestli existuje opakující se platební pole.
Tisk a podepsání hotovo	folder.folderRecipientParties.printAndSignCompleted	boolean	Určuje, jestli je proces tisku a podpisu dokončený.
Paid	folder.folderRecipientParties.paid	boolean	Určuje, jestli byla platba dokončena.
Volitelné podepisující osoby povoleny	folder.folderRecipientParties.allowOptionalSigner	boolean	Určuje, jestli je tento příjemce volitelným podepisovačem.
Volitelné podepisující osoby	folder.folderRecipientParties.optionalSigners	array of integer	Seznam volitelných ID stran podepisující osoby pro tuto obálku.
Autor podpisové adresy URL	folder.folderAccessURLForAuthor	string	Adresa URL, pomocí které může odesílatel získat přístup k obálce.
Adresa URL přístupu konceptu	folder.draftFolderAccessURL	string	Adresa URL použitá pro přístup k konceptu obálky.
Podepisování na panelu	folder.boardRoomSign	boolean	Určuje, jestli je povolený režim podepisování tabulových místností.
Zahrnout logo	folder.includeLogo	boolean	Označuje, jestli je logo společnosti součástí e-mailů.
Barva pozadí tlačítka	folder.email_btnBgColor	string	Barva pozadí tlačítka e-mailu
Barva textu tlačítka	folder.email_btnTxtColor	string	Barva textu tlačítka e-mailu
Logo e-mailu	folder.emailTemplateLogo	string	Adresa URL loga použitá v e-mailové šabloně.
ID šablony e-mailu	folder.emailTemplateId	integer	Jedinečný identifikátor šablony e-mailu.
Záhlaví e-mailu	folder.emailHeader	string	Text záhlaví použitý v e-mailech s oznámeními.
Zápatí e-mailu	folder.emailFooter	string	Text zápatí použitý v e-mailech s oznámeními
Vyprázdnění naplánované	folder.purgeFlag	boolean	Určuje, jestli je obálka naplánována pro vyprázdnění.
Vyprázdnit počáteční datum	folder.purgeStartDate	string	Datum, od kterého je naplánováno vymazání.
Vyprázdnit koncové datum	folder.purgeEndDate	string	Datum, kdy je vyprázdnění naplánováno na dokončení.
ID hromadného odeslání	folder.bulkId	integer	Jedinečný identifikátor operace hromadného odeslání.
Vynucení pořadí podpisu	folder.enforceSignWorkflow	boolean	Určuje, jestli se příjemci musí přihlásit k definované sekvenci.
Aktuální krok	folder.currentWorkflowStep	integer	Aktuální krok v pracovním postupu podepisování.
Zdroj transakcí	folder.transactionSource	string	Zdrojový systém, který inicioval tuto transakci.
Upravitelný	folder.editable	boolean	Určuje, jestli je položka upravitelná.
podepisování In-Person	folder.inPersonSignable	boolean	Určuje, zda lze obálku podepsat osobně.
Přepsání připomenutí	folder.overrideAccountReminders	boolean	Určuje, jestli se přepíše nastavení připomenutí na úrovni účtu.
Přepsat delegování	folder.overrideAccountRecipientDelegation	boolean	Určuje, jestli se přepíše nastavení delegování na úrovni účtu.
Povolit delegování	folder.allowRecipientsToDelegate	boolean	Určuje, jestli mají příjemci povoleno delegovat podepisování.
ID	folder.envelopeId	integer	Jedinečný identifikátor obálky.
Name	folder.envelopeName	string	Název obálky.
ID původce	folder.envelopeOriginatorId	integer	Jedinečný identifikátor uživatele, který obálku vytvořil.
ID společnosti	folder.envelopeCompanyId	integer	Jedinečný identifikátor společnosti, která obálku vlastní.
Date	folder.envelopeDate	integer	Datum vytvoření obálky (unixové časové razítko v milisekundách).
Sdílené datum	folder.envelopeSharedDate	integer	Datum, kdy byla obálka sdílena (unixové časové razítko v milisekundách).
Stav	folder.envelopeStatus	string	Aktuální stav obálky.
ID kontraktů	folder.envelopeContractIds	array of integer	Seznam ID kontraktů přidružených k této obálce.
Oprávnění příjemce	folder.envelopePartyPermissions	array of object	Seznam oprávnění příjemců pro tuto obálku.
ID příjemce	folder.envelopePartyPermissions.partyId	integer	Jedinečný identifikátor příjemce.
ID příjemce	folder.envelopePartyPermissions.partyDetails.partyId	integer	Jedinečný identifikátor příjemce.
Křestní jméno	folder.envelopePartyPermissions.partyDetails.firstName	string	Jméno příjemce.
Příjmení	folder.envelopePartyPermissions.partyDetails.lastName	string	Příjmení příjemce.
E-mailová adresa	folder.envelopePartyPermissions.partyDetails.emailId	string	E-mailová adresa příjemce.
Zástupný text	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Určuje, jestli je tato strana zástupným příjemcem.
Address	folder.envelopePartyPermissions.partyDetails.address	string	Fyzická adresa příjemce.
Datum vytvoření	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	Datum vytvoření záznamu (unixové časové razítko v milisekundách).
Odhlášení e-mailů	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Určuje, jestli se příjemce odhlásil z e-mailových oznámení.
Jedinečné ID příjemce	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	Jedinečný systémový identifikátor tohoto příjemce.
Úroveň ověřování	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	Metoda ověřování požadovaná pro tohoto příjemce.
Datum aktualizace hesla	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	Datum poslední aktualizace hesla.
Aktualizovaný stav hesla	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Určuje, jestli se heslo aktualizovalo.
ID společnosti	folder.envelopePartyPermissions.partyDetails.companyId	integer	Jedinečný identifikátor společnosti.
Role uživatele	folder.envelopePartyPermissions.partyDetails.userRole	string	Role přiřazená uživateli.
Oddělení	folder.envelopePartyPermissions.partyDetails.department	string	Oddělení, do které uživatel patří.
Title	folder.envelopePartyPermissions.partyDetails.title	string	Pracovní pozice uživatele.
Aktivní	folder.envelopePartyPermissions.partyDetails.active	boolean	Určuje, jestli je uživatel nebo záznam aktivní.
Locale	folder.envelopePartyPermissions.partyDetails.requestLocale	string	Nastavení národního prostředí pro uživatele.
Sdílení s oddělením	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Určuje, jestli jsou obálky sdíleny napříč oddělením.
Vytáčení kódu	folder.envelopePartyPermissions.partyDetails.dialingCode	string	Mezinárodní číselný kód pro telefonní číslo.
Číslo mobilního zařízení	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	Číslo mobilního telefonu.
Filtr stavu	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	Filtr pro stav dokumentu.
Filtr kalendářních dat	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	Filtr pro datum dokumentu.
Zabezpečený přístup k polím	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Určuje, jestli má uživatel přístup k zabezpečeným polím.
Rozbalit boční panel	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Určuje, jestli je boční panel ve výchozím nastavení rozbalený.
Adv. Ověření e-mailu	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Určuje, jestli je povolené rozšířené ověření e-mailu.
ID správce	folder.envelopePartyPermissions.partyDetails.managerId	string	Jedinečný identifikátor správce uživatele.
Počet přihlášení	folder.envelopePartyPermissions.partyDetails.loginCount	integer	Počet přihlášení uživatele.
E-mail pro resetování hesla	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Určuje, jestli se má odeslat e-mail pro resetování hesla.
ID oddělení	folder.envelopePartyPermissions.partyDetails.departmentId	string	Jedinečný identifikátor oddělení.
Primární společnost	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	Primární společnost přidružená k uživateli.
Typ zařízení	folder.envelopePartyPermissions.partyDetails.deviceType	string	Typ použitého zařízení.
Token zařízení	folder.envelopePartyPermissions.partyDetails.deviceToken	string	Token nabízeného oznámení pro zařízení.
Popis subdodavatele	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	Popis subdodavatele nebo externího podepisující osoby.
Organizace subdodavatelů	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	Název subdodavatele nebo externího podepisující osoby.
Datum přidání subdodavatele	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	Datum přidání subdodavatele (unixové časové razítko v milisekundách).
Source	folder.envelopePartyPermissions.partyDetails.source	string	Zdrojový systém, ze kterého byl externí podepisující uživatel přidán.
Vytáčení kódu	folder.envelopePartyPermissions.dialingCode	string	Mezinárodní číselný kód pro telefonní číslo.
Číslo mobilního zařízení	folder.envelopePartyPermissions.mobileNumber	string	Číslo mobilního telefonu.
Typ podpisu	folder.envelopePartyPermissions.signerSignatureType	string	Typ podpisu, který podepisující znak použije.
Permissions	folder.envelopePartyPermissions.contractPermissions	string	Oprávnění udělená této straně smlouvy.
Podpisová objednávka	folder.envelopePartyPermissions.partySequence	integer	Pořadové číslo podpisové objednávky pro tohoto příjemce.
Pořadí pracovních postupů	folder.envelopePartyPermissions.workflowSignSequence	integer	Pořadové číslo podepisujícího pracovního postupu
ID obálky	folder.envelopePartyPermissions.envelopeId	integer	Jedinečný identifikátor obálky.
ID společnosti příjemce	folder.envelopePartyPermissions.partyCompanyId	integer	Jedinečný identifikátor společnosti přidružené k tomuto příjemci.
Režim sdílení	folder.envelopePartyPermissions.sharingMode	string	Režim sdílení pro tuto obálku.
Adresa URL pro přístup příjemce	folder.envelopePartyPermissions.folderAccessURL	string	Adresa URL, pomocí které může příjemce získat přístup k obálce a podepsat ji.
Režim zabezpečení	folder.envelopePartyPermissions.securityMode	string	Režim zabezpečení použitý na tuto obálku.
Komentáře	folder.envelopePartyPermissions.extraComments	string	Další komentáře, které jsou součástí obálky.
Povolit změnu názvu	folder.envelopePartyPermissions.allowNameChange	boolean	Určuje, jestli má příjemce povoleno aktualizovat své jméno.
Název aktualizován	folder.envelopePartyPermissions.signerNameUpdated	boolean	Určuje, jestli podepisující správce aktualizoval své jméno.
Úroveň ověřování podepisující osoby	folder.envelopePartyPermissions.signerAuthenticationLevel	string	Úroveň ověřování vyžadovaná pro podepisující osoby.
Přístupový kód	folder.envelopePartyPermissions.userDefinedAccessCode	string	Vlastní přístupový kód definovaný pro podepisující osoby.
ID podpisu	folder.envelopePartyPermissions.signatureId	string	Jedinečný identifikátor podpisu.
Role příjemce	folder.envelopePartyPermissions.partyRole	string	Role přiřazená tomuto příjemci v pracovním postupu podepisování.
Pole společnosti	folder.envelopePartyPermissions.companyFieldValue	string	Hodnota pole název společnosti v podpisu.
Pole nadpisu	folder.envelopePartyPermissions.titleFieldValue	string	Hodnota pole názvu v podpisu.
Důvod podepisování	folder.envelopePartyPermissions.reasonSigning	string	Důvod, proč příjemce dokument podepíše.
Přidáno platební pole	folder.envelopePartyPermissions.payFieldAdded	boolean	Určuje, jestli bylo přidáno pole platby.
Příjemce	folder.envelopePartyPermissions.payee	boolean	Určuje, jestli je příjemce příjemcem.
Opakovaná platba	folder.envelopePartyPermissions.recurringFieldExist	boolean	Určuje, jestli existuje opakující se platební pole.
Tisk a podepsání hotovo	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Určuje, jestli je proces tisku a podpisu dokončený.
Paid	folder.envelopePartyPermissions.paid	boolean	Určuje, jestli byla platba dokončena.
Úroveň ověřování	folder.envelopeAuthenticationLevel	string	Úroveň ověřování vyžadovaná pro obálku.
Hromadné jednotné přihlašování	folder.allowSingleSignerInBulk	boolean	Určuje, jestli je jednotné přihlašování povolené v režimu hromadného odesílání.
Pojmenování File-Based	folder.folderNameBasedOnFileNaming	boolean	Určuje, jestli je název složky založený na názvu souboru.
Název File-Based doc	folder.documentNameBasedOnFileNaming	boolean	Určuje, jestli je název dokumentu založený na názvu souboru.
Název File-Based certifikátu	folder.certificateNameBasedOnFileNaming	boolean	Určuje, jestli je název certifikátu založený na názvu souboru.
Pojmenování souborů pre-Exec	folder.enableFileNamingBeforeExecution	boolean	Určuje, jestli je před spuštěním dokumentu povolené pojmenování souboru.
Příjemce přidán	folder.payeeAddedd	boolean	Určuje, jestli byl příjemce přidán.
Self-Signing povoleno	folder.selfSignerEnabled	boolean	Označuje, jestli je povolený režim samoobslužného podepisování.
Notář povoleno	folder.notaryEnabled	boolean	Určuje, jestli je povolené podepisování notáře.
Omezená viditelnost	folder.limitedVisibilityFlag	boolean	Určuje, jestli je pro tuto obálku povolená omezená viditelnost.
Viditelnost po podepsání	folder.postSigningVisibility	boolean	Označuje, jestli je povolená viditelnost po podepsání.
Mokrý podpis	folder.wetSignatureEnabled	boolean	Určuje, jestli jsou povolené mokré podpisy.
Sloučit povoleno	folder.mergeEnabled	boolean	Určuje, jestli je povolené slučování dokumentu.
Vložené podpisové relace	embeddedSigningSessions	array of object	Seznam vložených podpisových relací, jeden na příjemce. Existuje pouze v případech, kdy je hodnota createEmbeddedSigningSession pravdivá.
E-mail podepisující osoby	embeddedSigningSessions.emailIdOfSigner	string	E-mailová adresa příjemce pro tuto vloženou podpisovou relaci.
Podpisový token	embeddedSigningSessions.embeddedToken	string	Jedinečný token pro vloženou podpisovou relaci tohoto příjemce.
Adresa URL podpisové relace	embeddedSigningSessions.embeddedSessionURL	string	Adresa URL pro otevření nebo vložení tohoto příjemce k podepsání dokumentu.
Vložený odesílající token	embeddedToken	string	Token pro vloženou odesílající relaci. Existuje pouze v případech, kdy je hodnota createEmbeddedSendingSession pravdivá.
Adresa URL relace pro odesílání	embeddedSessionURL	string	Adresa URL pro otevření nebo vložení obálky pro autora obálky k přípravě a odeslání obálky. Existuje pouze v případech, kdy je hodnota createEmbeddedSendingSession pravdivá.
Result	result	string	Výsledek operace.
Message	message	string	Zpráva popisující výsledek operace.

Vytvoření obálky ze šablony

ID operace:: CreateEnvelopefromTemplate

Vytvoří a odešle obálku pomocí existující šablony. Podrobnosti o příjemci je možné přizpůsobit.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název obálky	folderName		string	Název složky dokumentů. Pokud tuto hodnotu nezadáte, název složky dokumentů se zachová stejně jako názvy šablon.
ID šablony	templateIds	True	array of integer	Pole ID šablon, které chcete použít k vytvoření dokumentů pro tuto složku.
Pole	fields		object	Hodnoty polí použité v šablonách můžete předat k jejich předběžnému vyplňování v dokumentech vytvořených ze šablony. FIELD_NAME je název pole použitého v šabloně. FIELD_VALUE je hodnota pole dokumentu.
Rozšířené ověření e-mailu	allowAdvancedEmailValidation		boolean	Ověřte e-mailové adresy stran, pokud jsou nastavené jako true.
Křestní jméno	firstName	True	string	Jméno příjemce.
Příjmení	lastName	True	string	Příjmení příjemce.
E-mailová adresa	emailId	True	string	E-mailová adresa příjemce.
oprávnění	permission	True	string
Sequence	sequence	True	integer	Toto pole slouží k přiřazení pořadového čísla příjemci v seznamu stran příjemců. Pro každou stranu použijte jedinečná pořadová čísla začínající 1, například 1,2,3,4.... Pokud se v pracovním postupu podepisování zobrazí jedna osoba několikrát, přiřaďte pokaždé, když se příjemce opakuje, jinou posloupnost.
signerAuthLevels	signerAuthLevel		string	Úroveň ověřování, kterou bude podepisující člen využít pro účely ověření
Je zástupný symbol.	isPlaceholder		boolean	Toto pole slouží k zahájení party jako zástupného symbolu. Poznámka: 1. hodnota parametru firstName, lastName, emailId musí být prázdná pro tuto stranu. 2. Pokud chcete přidat zástupný symbol, musí se jeden příjemce znovu připojit s oprávněním "PARTY_ASSIGNER".
Role příjemce	partyRole		string	Pomocí tohoto pole můžete přiřadit roli zástupného symbolu.
Povolit změnu názvu	allowNameChange		string	Hodnota může mít hodnotu true nebo false. Tento parametr použijte, pokud chcete, aby podepisující proces před dokončením procesu podepisování aktualizoval křestní jméno a příjmení.
Pořadí pracovních postupů	workflowSequence		integer	Přiřaďte tomuto příjemci pořadové číslo pracovního postupu. Když je zapnuté pořadí přihlášení, dostanou příjemci pozvánku k podepisování ve vzestupném pořadí.
ID e-mailu hostitele	hostEmailId		string	E-mailová adresa správce In-Person.
Přístupový kód	userDefinedAccessCode		string	Parametr bude obsahovat přístupový kód, pokud je hodnota signerAuthLevel nastavená na uživatelem definovaný přístupový kód pro ověřování. Poznámka: 1. Kódy nerozlišují malá a velká písmena. 2. Systém tento kód neodesílá, takže tento kód musíte sdílet s podepisující osoby přímo. 3. Přístupový kód může obsahovat abecedy, čísla a následující speciální znaky: @,&,{,},%,(,),~,\|,!,+,^.
Party Is Email Group	partyIsEmailGroup		boolean	Tento parametr použijte při vytváření strany hromadně. Poznámka: Pokud je tento parametr true, firstName, lastName a emailId této strany bude ignorován.
ID e-mailové skupiny	emailGroupId		integer	Předejte e-mail s ID skupiny, které chcete použít k hromadnému vytvoření.
Hromadné jednotné přihlašování	allowSingleSignerInBulk		boolean	Pomocí tohoto parametru můžete povolit přihlášení e-mailové skupiny jenom jedné osobě.
Vytáčení kódu	dialingCode		string	Toto pole slouží k přiřazení kódů pro telefonické připojení země jako předpony mobilních čísel příjemci v seznamu stran příjemců.
Číslo mobilního zařízení	mobileNumber		string	Toto pole slouží k přiřazení mobilního čísla příjemci v seznamu stran příjemců.
Heslo obálky	folderPassword		string	Toto heslo bude vyžadovat podepisující nebo autor k otevření digitálně podepsaného dokumentu. Pokud je parametr prázdný, nebude se k otevření digitálně podepsaného dokumentu vyžadovat žádné heslo.
Pořadí přihlášení	signInSequence		boolean	Toto pole slouží k určení, jestli příjemci podepíší dokumenty obálky v posloupnosti. Pokud je false, dostanou všichni příjemci e-mail s pozvánkou současně. Pokud ano, každý příjemce obdrží e-mail s pozvánkou po sobě po dokončení požadovaného úkolu, například podepsání dokumentů nebo vyplňování polí atd.
Povolení osobně	inPersonEnable		boolean	Toto pole slouží k zahájení procesu podepisování osobně, který se dá snadno dokončit na jakémkoli zařízení během několika minut a vyhne se podpisům založeným na e-mailu, pokud je to potřeba. Pokud je false, dostanou všichni příjemci e-mail s pozvánkou současně. Pokud je to pravda, správce osobně obdrží e-mail s pozvánkou, aby zahájil proces podepisování pro podepisující osobu.
Odeslat	sendNow		boolean	Pokud je tato možnost povolená, Foxit eSign okamžitě pošle jedinečný podpisový odkaz na e-mailovou adresu každého příjemce. Pokud chcete místo toho uložit obálku jako koncept, zakažte ji.
Podepsat adresu URL úspěchu – Všechny strany	signSuccessUrlAllParties		boolean	Pokud je nastavená hodnota true, podepisující uživatel se po úspěšném podepsání přesměruje na adresu URL zadanou v signSuccessUrl. To platí pouze v případě, že sendNow je pravdivý.
Vytvoření vložené relace odesílání	createEmbeddedSendingSession		boolean	Pokud je nastavená hodnota true, vygeneruje vloženou adresu URL pro otevření dokumentu, který připravuje zobrazení eSign foxit.
Oprava stran příjemců	fixRecipientParties		boolean	Pokud ano, pak v vloženém zobrazení pro odesílání nelze změnit strany obálky, které jsou již přidány jako součást této žádosti.
Oprava dokumentů	fixDocuments		boolean	Pokud ano, pak ve vloženém odesílání nelze změnit dokumenty pro obálku, které jsou již přidány jako součást této žádosti.
Adresa URL pro úspěšné odeslání	sendSuccessUrl		string	Zadejte absolutní adresu URL cílové stránky, na kterou bude podepisující uživatel přesměrován po úspěšném odeslání složky v vloženém zobrazení pro odesílání.
Odeslat adresu URL chyby	sendErrorUrl		string	Zadejte absolutní adresu URL cílové stránky, na kterou se podepisující uživatel přesměruje, pokud při odesílání složky ve vloženém zobrazení pro odesílání dojde k chybě.
Skrýt možnost výběru podepisující osoby	hideSignerSelectOption		boolean	Pokud je pravda, skryje vstupní pole "Existující jméno/e-mail podepisující osoby" ve vložené odesílající relaci.
Skrýt akce podepisující osoby	hideSignerActions		boolean	Pokud je pravda, skryje se akce "upravit", "změnit" a "odebrat" u stran příjemců ve vložené odesílající relaci.
Skrýt jméno odesílatele	hideSenderName		boolean	Pokud ano, skryje se jméno odesílatele u stran příjemců ve vložené odesílající relaci.
Skrýt tlačítko Odeslat	hideSendButton		boolean	Pokud ano, skryje se tlačítko Odeslat ve vložené odesílající relaci.
Skrýt název složky	hideFolderName		boolean	Pokud je hodnota true, skryje se název složky při navigaci v obou vložených relací.
Skrýt název dokumentů	hideDocumentsName		boolean	Pokud ano, skryje název dokumentu v obou vložených relacích.
Skrýt tlačítko Přidat mě	hideAddMeButton		boolean	Pokud je pravda, skryje tlačítko Přidat mě u stran příjemců ve vložené odesílající relaci.
Skrýt tlačítko Přidat nový	hideAddNewButton		boolean	Pokud ano, skryje tlačítko Přidat nový u stran příjemců ve vložené odesílající relaci.
Skrýt tlačítko Přidat skupinu	hideAddGroupButton		boolean	Pokud ano, skryje tlačítko Přidat skupinu u stran příjemců ve vložené odesílající relaci.
Vytvoření vložené podpisové relace	createEmbeddedSigningSession		boolean	Podpisový token relace se vygeneruje bez odeslání e-mailů příjemcům.
Vytvoření vložené podpisové relace pro všechny strany	createEmbeddedSigningSessionForAllParties		boolean	Pokud je nastavená hodnota true, vygeneruje se vložená podpisová adresa URL pro každého příjemce v obálce. Pokud je false, dostanou vloženou relaci jenom příjemci uvedení v id e-mailu vložených podepisujících.
Id e-mailu vložených podepisujících podepisujících	embeddedSignersEmailIds		array of string	Pole e-mailových ID příjemců, pro které je potřeba vytvořit vloženou podpisovou relaci. ID e-mailu od příjemců, které byly přidány do seznamu stran.
Podepsat adresu URL úspěchu	signSuccessUrl		string	Zadejte absolutní adresu URL pro podepisující osoby, které budou přesměrovány po úspěšném přihlášení do vloženého podpisového zobrazení.
Adresa URL pro odmítnutí podpisu	signDeclineUrl		string	Zadejte absolutní adresu URL pro podepisující osoby, na které budou přesměrovány, pokud se odmítne přihlásit do vloženého zobrazení podepisování.
Podepsat pozdější adresu URL	signLaterUrl		string	Zadejte absolutní adresu URL pro podepisující osoby, na které budou přesměrovány, pokud se rozhodnete přihlásit se později v vloženém zobrazení podepisování.
Přihlašovací adresa URL chyby	signErrorUrl		string	Zadejte absolutní adresu URL pro podepisující osoby, na které se při podepisování dokumentu ve vloženém zobrazení podepisování přesměrují, na které dojde k chybě.
Skrýt další povinné pole Btn	hideNextRequiredFieldBtn		boolean	Pokud je nastavená hodnota true, skryje navigační tlačítko, které přesune podepisující osoby do dalšího požadovaného pole.
Barva motivu	themeColor		string	Zadejte hodnotu CSS a nastavte barvu motivu.
Skrýt odmítaný podpis	hideDeclineToSign		boolean	Pokud je nastavená hodnota true, skryje na přihlašovací obrazovce možnost Odmítnout podepsat.
Skrýt další akci	hideMoreAction		boolean	Pokud je nastavená hodnota true, skryje tlačítko Další akce v relaci odesílání a podepisování. Nemá žádný vliv, pokud je odeslat nyní pravdivý.
Skrýt možnost Přidat strany	hideAddPartiesOption		boolean	Pokud je nastavena hodnota true, skryje možnost přidat strany v režimu konceptů a vytváření šablon.
Vypršení platnosti relace	sessionExpire		boolean	Pokud chcete zahájit platnost vložené podpisové relace, nastavte hodnotu true.
Vypršení platnosti	expiry		integer	Vyžaduje se, pokud je relaceExpire pravdivá. Zadejte dobu trvání v milisekundách konce platnosti vložené podpisové relace.
E-mail odesílatele	senderEmail		string	zadejte do svého účtu e-mail jiného uživatele, který se použije k odeslání této složky dokumentů příjemcům.
Povolit odesílání a vloženou podpisové relace	allowSendNowAndEmbeddedSigningSession		boolean	Pokud je nastavena hodnota true, Foxit eSign pošle každému příjemci podpisový e-mail s pozvánkou a také vygeneruje vložený podpisový odkaz pro příjemce, jehož e-mail je součástí vloženého e-mailu pro přihlášení. E-mail i vložený odkaz jsou aktivní současně.
Povolit krok za krokem	enableStepByStep		boolean	Pokud chcete povolit krok za krokem v vložené odesílající relaci.

Návraty

Name	Cesta	Typ	Description
Result	result	string	Určuje, jestli operace proběhla úspěšně (např. "success").
Message	message	string	Popis výsledku operace.
Vložené podpisové relace	embeddedSigningSessions	array of object	Seznam vložených podpisových relací, jeden na příjemce. Existuje pouze v případech, kdy je hodnota createEmbeddedSigningSession pravdivá.
E-mail podepisující osoby	embeddedSigningSessions.emailIdOfSigner	string	E-mailová adresa příjemce pro tuto vloženou podpisovou relaci.
Podpisový token	embeddedSigningSessions.embeddedToken	string	Jedinečný token pro vloženou podpisovou relaci tohoto příjemce.
Adresa URL podpisové relace	embeddedSigningSessions.embeddedSessionURL	string	Adresa URL pro otevření nebo vložení tohoto příjemce k podepsání dokumentu.
Vložený odesílající token	embeddedToken	string	Token pro vloženou odesílající relaci. Existuje pouze v případech, kdy je hodnota createEmbeddedSendingSession pravdivá.
Adresa URL relace pro odesílání	embeddedSessionURL	string	Adresa URL pro otevření nebo vložení obálky pro autora obálky k přípravě a odeslání obálky. Existuje pouze v případech, kdy je hodnota createEmbeddedSendingSession pravdivá.
ID	folder.folderId	integer	Jedinečné ID vytvořené obálky. Použijte ji k odkazu na obálku v následných akcích.
Name	folder.folderName	string	Název obálky.
Vlastní název	folder.folderCustomName	string	Vlastní název přiřazený k obálce.
Heslo	folder.folderPassword	string	Heslo nastavené pro obálku, pokud existuje.
ID autora	folder.folderAuthorId	integer	Jedinečné ID uživatele, který obálku vytvořil.
Jméno autora	folder.folderAuthorFirstName	string	Jméno autora obálky.
Příjmení autora	folder.folderAuthorLastName	string	Příjmení tvůrce obálky.
Vytvořit e-mail	folder.folderAuthorEmail	string	E-mailová adresa tvůrce obálky.
Role autora	folder.folderAuthorRole	string	Role účtu tvůrce obálky.
ID společnosti	folder.folderCompanyId	integer	Jedinečné ID společnosti, do které obálka patří.
Datum vytvoření	folder.folderCreationDate	integer	Datum a čas vytvoření obálky v milisekundách unixu.
Datum odeslání	folder.folderSentDate	integer	Datum a čas odeslání obálky příjemcům v milisekundách unixu.
Stav	folder.folderStatus	string	Aktuální stav obálky (např. SHARED, EXECUTED, DRAFT, CANCELLED).
Vlastní pole 1	folder.custom_field1	string	Hodnota vlastního pole 1 nastavená na obálku.
Vlastní pole 2	folder.custom_field2	string	Hodnota vlastního pole 2 nastavená na obálku.
Metadata	folder.metadata	string	Všechna další metadata přidružená k obálce.
ID dokumentů	folder.folderDocumentIds	array of integer	Seznam ID dokumentů obsažených v této obálce.
Documents	folder.documentsList	array of object	Podrobnosti o každém dokumentu, který je součástí obálky.
ID dokumentu	folder.documentsList.documentId	integer	Jedinečný identifikátor dokumentu.
ID smlouvy	folder.documentsList.contractId	integer	Jedinečný identifikátor smlouvy přidružené k tomuto dokumentu.
ID společnosti	folder.documentsList.companyId	integer	Jedinečné ID společnosti, do které tento dokument patří.
Vytvořeno kým	folder.documentsList.contractCreatedBy	integer	ID uživatele osoby, která smlouvu vytvořila.
Vytvořeno dne	folder.documentsList.contractCreatedOn	string	Datum vytvoření smlouvy.
Typ smlouvy	folder.documentsList.contractType	string	Typ smlouvy.
Stav dokumentu	folder.documentsList.contractStatus	string	Aktuální stav podepisování dokumentu (např. WAITING_FOR_SIGNATURE, EXECUTED).
Upravitelný	folder.documentsList.editable	boolean	Určuje, zda lze dokument upravit.
ID verze	folder.documentsList.contractVersionId	integer	Jedinečné ID aktuální verze dokumentu.
Název verze	folder.documentsList.contractVersionName	string	Název aktuální verze dokumentu.
Popis verze	folder.documentsList.contractVersionDesc	string	Popis aktuální verze dokumentu
Verze vytvořená uživatelem	folder.documentsList.versionCreatedby	integer	ID uživatele osoby, která vytvořila tuto verzi dokumentu.
Verze vytvořená dne	folder.documentsList.versionCreatedOn	string	Datum vytvoření této verze dokumentu.
Číslo verze	folder.documentsList.contractVersionNumber	integer	Číslo verze dokumentu.
Zdroj transakcí	folder.documentsList.contractTransactionSource	string	Zdroj transakce kontraktu.
Příjemci	folder.folderRecipientParties	array of object	Seznam příjemců pro tuto obálku, včetně jejich jednotlivých podpisových odkazů.
ID příjemce	folder.folderRecipientParties.partyId	integer	Jedinečný identifikátor příjemce.
ID příjemce	folder.folderRecipientParties.partyDetails.partyId	integer	Jedinečný identifikátor příjemce.
Křestní jméno	folder.folderRecipientParties.partyDetails.firstName	string	Jméno příjemce.
Příjmení	folder.folderRecipientParties.partyDetails.lastName	string	Příjmení příjemce.
Email	folder.folderRecipientParties.partyDetails.emailId	string	E-mailová adresa příjemce.
Je zástupný symbol.	folder.folderRecipientParties.partyDetails.placeholder	boolean	Určuje, jestli je tento příjemce zástupný symbol.
Address	folder.folderRecipientParties.partyDetails.address	string	Adresa příjemce.
Datum vytvoření účtu	folder.folderRecipientParties.partyDetails.dateCreated	integer	Datum vytvoření účtu příjemce v milisekundách unixu.
Odhlášení e-mailů	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Určuje, jestli se příjemce odhlásil z e-mailových oznámení.
Jedinečné ID strany	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Jedinečný identifikátor řetězce příjemce.
Úroveň ověřování	folder.folderRecipientParties.partyDetails.authenticationLevel	string	Úroveň ověřování vyžadovaná pro tohoto příjemce.
ID společnosti	folder.folderRecipientParties.partyDetails.companyId	integer	ID společnosti, do které příjemce patří.
Role uživatele	folder.folderRecipientParties.partyDetails.userRole	string	Role příjemce v rámci organizace.
Oddělení	folder.folderRecipientParties.partyDetails.department	string	Oddělení příjemce.
Title	folder.folderRecipientParties.partyDetails.title	string	Pracovní pozice příjemce.
Aktivní	folder.folderRecipientParties.partyDetails.active	boolean	Určuje, jestli je účet příjemce aktivní.
Vytáčení kódu	folder.folderRecipientParties.partyDetails.dialingCode	string	Kód vytáčení země pro telefonní číslo příjemce.
Číslo mobilního zařízení	folder.folderRecipientParties.partyDetails.mobileNumber	string	Číslo mobilního telefonu příjemce.
Popis subdodavatele	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Popis subdodavatele, pokud je to možné.
Organizace subdodavatelů	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	Název organizace subdodavatele, pokud je to možné.
Datum přidání subdodavatele	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Datum přidání subdodavatele v milisekundách unixu.
Source	folder.folderRecipientParties.partyDetails.source	string	Zdroj, přes který byl příjemce přidán.
Vytáčení kódu	folder.folderRecipientParties.dialingCode	string	Kód vytáčení země pro mobilní číslo příjemce.
Číslo mobilního zařízení	folder.folderRecipientParties.mobileNumber	string	Číslo mobilního zařízení příjemce.
Typ podpisu	folder.folderRecipientParties.signerSignatureType	string	Typ podpisu je pro tohoto příjemce povolený.
Permissions	folder.folderRecipientParties.contractPermissions	string	Podpisová oprávnění udělená tomuto příjemci (např. FILL_FIELDS_AND_SIGN).
Podpisová objednávka	folder.folderRecipientParties.partySequence	integer	Pozice tohoto příjemce v podpisové objednávce.
Pořadí pracovních postupů	folder.folderRecipientParties.workflowSignSequence	integer	Číslo sekvence podepisování pracovního postupu pro tohoto příjemce.
ID obálky	folder.folderRecipientParties.envelopeId	integer	ID obálky, do které tento příjemce patří.
ID společnosti strany	folder.folderRecipientParties.partyCompanyId	integer	ID společnosti, do které tento příjemce patří.
Režim sdílení	folder.folderRecipientParties.sharingMode	string	Metoda použitá ke sdílení dokumentu s tímto příjemcem (např. e-mailem).
Podpisová adresa URL	folder.folderRecipientParties.folderAccessURL	string	Jedinečná podpisová adresa URL tohoto příjemce. Použijte ho k přímému sdílení podpisového odkazu.
Režim zabezpečení	folder.folderRecipientParties.securityMode	string	Režim zabezpečení použitý pro přístup tohoto příjemce.
Další komentáře	folder.folderRecipientParties.extraComments	string	Všechny další komentáře zahrnuté v podpisové pozvánce pro tohoto příjemce.
Povolit změnu názvu	folder.folderRecipientParties.allowNameChange	boolean	Určuje, jestli má příjemce povoleno změnit své jméno před podepsáním.
Název aktualizován	folder.folderRecipientParties.signerNameUpdated	boolean	Určuje, jestli příjemce aktualizoval zobrazované jméno.
Úroveň ověřování	folder.folderRecipientParties.signerAuthenticationLevel	string	Metoda ověřování požadovaná pro přístup k dokumentu tomuto příjemci.
Přístupový kód	folder.folderRecipientParties.userDefinedAccessCode	string	Vlastní přístupový kód vyžadovaný pro otevření dokumentu pro tohoto příjemce.
ID podpisu	folder.folderRecipientParties.signatureId	string	ID uloženého podpisu použitého tímto příjemcem.
Role příjemce	folder.folderRecipientParties.partyRole	string	Role přiřazená tomuto příjemci v obálce.
Hodnota pole společnosti	folder.folderRecipientParties.companyFieldValue	string	Hodnota pole společnosti byla předem vyplněna pro tohoto příjemce.
Hodnota pole nadpisu	folder.folderRecipientParties.titleFieldValue	string	Hodnota pole nadpisu byla předem vyplněna pro tohoto příjemce.
Důvod podepisování	folder.folderRecipientParties.reasonSigning	string	Důvod podpisu poskytnutého tímto příjemcem.
Přidáno pole Zaplatit	folder.folderRecipientParties.payFieldAdded	boolean	Určuje, jestli bylo pro tohoto příjemce přidáno pole platby.
Is Payee	folder.folderRecipientParties.payee	boolean	Určuje, jestli je příjemce příjemcem příjemce.
Opakující se pole existuje.	folder.folderRecipientParties.recurringFieldExist	boolean	Určuje, jestli pro tohoto příjemce existují opakující se pole plateb.
Tisk a podepsání dokončeno	folder.folderRecipientParties.printAndSignCompleted	boolean	Určuje, jestli příjemce dokončil akci tisku a podpisu.
Povolit volitelné podepisující osoby	folder.folderRecipientParties.allowOptionalSigner	boolean	Určuje, jestli může být tento příjemce vynechán jako volitelný podepisující uživatel.
Volitelné podepisující osoby	folder.folderRecipientParties.optionalSigners	string	Seznam volitelných podepisujících, kteří jsou přidruženi k tomuto příjemci, pokud existuje.
Paid	folder.folderRecipientParties.paid	boolean	Určuje, jestli příjemce dokončil platbu.
Adresa URL pro autory přístupu	folder.folderAccessURLForAuthor	string	Adresa URL pro autora obálky pro přístup k dokumentu.
Adresa URL přístupu konceptu	folder.draftFolderAccessURL	string	Adresa URL pro přístup k obálce v době, kdy je ve stavu konceptu.
Sign (Znaménko místnosti)	folder.boardRoomSign	boolean	Určuje, jestli je pro tuto obálku povolené podepisování tabulových místností.
Zahrnout logo	folder.includeLogo	boolean	Určuje, jestli je logo společnosti součástí e-mailových oznámení.
Barva tlačítka e-mailu	folder.email_btnBgColor	string	Barva pozadí tlačítka akce v podpisovém e-mailu
Barva textu tlačítka e-mail	folder.email_btnTxtColor	string	Barva textu tlačítka akce v podpisovém e-mailu
Logo e-mailu	folder.emailTemplateLogo	string	Obrázek loga použitý v e-mailové šabloně.
ID šablony e-mailu	folder.emailTemplateId	integer	ID šablony e-mailu použité k podepisování oznámení.
Záhlaví e-mailu	folder.emailHeader	string	Vlastní text záhlaví při podpisových e-mailech s oznámením.
Zápatí e-mailu	folder.emailFooter	string	Vlastní text zápatí při podepisování e-mailů s oznámením.
Vyprázdnění naplánované	folder.purgeFlag	boolean	Určuje, jestli je tato obálka naplánovaná pro automatické vyprázdnění.
Vyprázdnit počáteční datum	folder.purgeStartDate	string	Datum, od kterého začíná období vyprázdnění.
Vyprázdnit koncové datum	folder.purgeEndDate	string	Datum, kdy bude obálka vyprázdněna.
Hromadné ID	folder.bulkId	integer	ID dávky hromadného odeslání, do které tato obálka patří, pokud existuje.
Vynucení pořadí podpisu	folder.enforceSignWorkflow	boolean	Určuje, jestli se příjemci musí přihlásit k zadané objednávce.
Aktuální krok pracovního postupu	folder.currentWorkflowStep	integer	Aktuální krok v pracovním postupu podepisování.
Zdroj transakcí	folder.transactionSource	string	Zdroj, který inicioval tuto obálku transakce.
Upravitelný	folder.editable	boolean	Určuje, jestli je možné obálku i nadále upravovat.
podepisování In-Person	folder.inPersonSignable	boolean	Určuje, zda lze obálku podepsat osobně.
Přepsání připomenutí	folder.overrideAccountReminders	boolean	Určuje, jestli se pro tuto obálku přepíše nastavení připomenutí na úrovni účtu.
Přepsat delegování	folder.overrideAccountRecipientDelegation	boolean	Určuje, jestli se pro tuto obálku přepíše nastavení delegování na úrovni účtu.
Povolit delegování	folder.allowRecipientsToDelegate	boolean	Určuje, jestli mají příjemci povoleno delegovat podpis na jinou osobu.
ID	folder.envelopeId	integer	Jedinečné ID obálky. Stejná hodnota jako ID obálky (folderId).
Name	folder.envelopeName	string	Název obálky. Stejná hodnota jako Název obálky (folderName).
ID původce	folder.envelopeOriginatorId	integer	ID uživatele osoby, která obálku vytvořila.
ID společnosti	folder.envelopeCompanyId	integer	ID společnosti, do které obálka patří.
Date	folder.envelopeDate	integer	Datum a čas vytvoření obálky v milisekundách unixu.
Sdílené datum	folder.envelopeSharedDate	integer	Datum a čas, kdy byla obálka sdílena s příjemci v milisekundách unixu.
Stav	folder.envelopeStatus	string	Aktuální stav obálky. Stejná hodnota jako Stav obálky (folderStatus).
ID kontraktů	folder.envelopeContractIds	array of integer	Seznam ID kontraktů přidružených k této obálce.
Oprávnění stran	folder.envelopePartyPermissions	array of object	Seznam příjemců a jejich podpisová oprávnění. Stejná struktura jako Příjemci.
ID příjemce	folder.envelopePartyPermissions.partyId	integer	Jedinečný identifikátor příjemce.
Podpisová adresa URL	folder.envelopePartyPermissions.folderAccessURL	string	Jedinečná podpisová adresa URL tohoto příjemce.
Permissions	folder.envelopePartyPermissions.contractPermissions	string	Podpisová oprávnění pro tohoto příjemce.
Podpisová objednávka	folder.envelopePartyPermissions.partySequence	integer	Pozice tohoto příjemce v podpisové objednávce.
Úroveň ověřování	folder.envelopeAuthenticationLevel	string	Úroveň ověřování použitá na celou obálku.
Povolit hromadnou registraci jednotného přihlašování	folder.allowSingleSignerInBulk	boolean	Určuje, jestli je jednotné přihlašování povolené v režimu hromadného odesílání.
Název založený na souboru	folder.folderNameBasedOnFileNaming	boolean	Určuje, jestli je název obálky odvozený od názvu souboru.
Název dokumentu založený na souboru	folder.documentNameBasedOnFileNaming	boolean	Určuje, jestli je název dokumentu odvozený od názvu souboru.
Název certifikátu založený na souboru	folder.certificateNameBasedOnFileNaming	boolean	Určuje, jestli je název certifikátu odvozený od názvu souboru.
Povolení pojmenování souborů	folder.enableFileNamingBeforeExecution	boolean	Určuje, jestli se před odesláním obálky zobrazí výzva k pojmenování souboru.
Příjemce přidán	folder.payeeAddedd	boolean	Označuje, zda příjemce byl přidán do obálky.
Podepisující sám sebe	folder.selfSignerEnabled	boolean	Určuje, jestli je odesílatel také podepisující na této obálce.
Notář povoleno	folder.notaryEnabled	boolean	Určuje, zda je pro tuto obálku povolena notace.
Omezená viditelnost	folder.limitedVisibilityFlag	boolean	Určuje, jestli je povolená omezená viditelnost dokumentu.
Viditelnost po podepsání	folder.postSigningVisibility	boolean	Určuje, jestli příjemci můžou po dokončení zobrazit podepsaný dokument.
Povolený mokrý podpis	folder.wetSignatureEnabled	boolean	Určuje, zda jsou pro tuto obálku povoleny mokré (ručně psané) podpisy.
Sloučit povoleno	folder.mergeEnabled	boolean	Určuje, jestli je pro tuto obálku povoleno slučování dokumentů.

Vytvoření šablony z adresy URL

ID operace:: CreateTemplatefromURL

Vytvoří novou šablonu pomocí veřejně přístupné adresy URL PDF.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název šablony	templateName	True	string	Název šablony. Musí končit příponou .pdf (např. onboarding.pdf).
Adresa URL šablony	templateUrl	True	string	Veřejně přístupná adresa URL dokumentu PDF, která se má použít jako šablona.
Typ vstupu	inputType	True	string	Metoda zadávání dokumentu. Pro tuto akci je vždy nastavená adresa URL.
Zpracování textových značek	processTextTags	True	boolean	Pokud je tato možnost povolená, Bude Foxit eSign prohledávat dokument textových značek a automaticky je převede na pole podpisu.
Zpracování polí Acro	processAcroFields	True	boolean	Pokud je tato možnost povolená, Foxit eSign prohledá dokument pro AcroFields a automaticky je převede na pole podpisu.
Sdílet vše	shareAll	True	boolean	Tuto šablonu můžete sdílet se všemi uživateli ve vašem účtu.
Počet stran	numberOfParties	True	integer	Přidejte do šablony počet stran. Hodnoty tohoto parametru by měly být menší než 20.
Barva motivu	themeColor		string	Zadejte hodnotu css pro barvu pro změnu motivu createEmbeddedTemplateSession .
Vytvořit e-mail	authorEmail		string	Zadejte e-mail jiného uživatele do účtu, který se použije jako autor této šablony.
Vytvoření vložené relace šablony	createEmbeddedTemplateSession		boolean	Pokud je nastavena hodnota true, vložená relace šablony pro přímé otevření šablony Foxit eSign připravuje zobrazení. K dispozici bude přetahování různých polí v šabloně.
Adresa URL pro přesměrování	redirectURL		string	Pokud je hodnota createEmbeddedTemplateSession pravdivá, je možné zadat absolutní adresu URL pro cílovou stránku na libovolném webu nebo aplikaci, na kterou se uživatel přesměruje po kliknutí na uložit a zavřít v vloženém zobrazení šablony.
Skrýt šablonu pro odeslání	hideSendTemplate		boolean	Pokud ano, skryje tlačítko Odeslat v vloženém zobrazení šablony.
Oprava stran příjemců	fixRecipientParties		boolean	Pokud ano, pak v vloženém zobrazení šablony nemůže změnit strany obálky, které jsou již přidány.
Pole	Fields		object
oprávnění	permission	True	string
Sequence	sequence	True	integer	Jedinečné pořadové číslo pro tuto stranu od 1. Definuje podpisové pořadí, když je zapnuté pořadí přihlášení.
Role příjemce	partyRole	True	string	Role přiřazená této straně v šabloně.
Skrýt další akci	hideMoreAction		boolean	Pokud ano, skryje tlačítko Další akce v relaci šablony.
Skrýt sdílení se všemi	hideShareWithAll		boolean	Pokud ano, v relaci šablony se možnost Sdílet se všemi skryje.
Skrýt přidání strany	hideAddParty		boolean	Pokud ano, skryje všechny možnosti přidání strany v relaci vložené šablony.
Tlačítko Skrýt mě	hideMeButton		boolean	Pokud je pravda, skryje tlačítko "Já" u stran příjemců v vložené relaci šablony.
Tlačítko Skrýt ostatní	hideOthersButton		boolean	Pokud je pravda, skryje tlačítko Ostatní na straně příjemců v vložené relaci šablony.
Skrýt existující možnost výběru kontaktu	hideExistingContactSelectOption		boolean	Pokud ano, skryje vstupní pole Najít a přidat existující kontakt u stran příjemců v vložené relaci šablony.
Skrýt jméno pole pro příjemce	hideFieldNameForRecipients		boolean	Skryjte názvy polí pro příjemce pro pole pro zadávání dat a upřesňující pole. (Kromě přepínače, zaškrtávacího políčka, obrázku a hypertextového odkazu)
Skrýt ohraničení zaškrtávacího políčka	hideCheckboxBorder		boolean	Ohraničení zaškrtávacího políčka bude v prováděných dokumentech skryté.

Návraty

Name	Cesta	Typ	Description
Result	result	string	Určuje, jestli operace proběhla úspěšně (např. "success").
Message	message	string	Popis výsledku operace.
ID	template.templateId	integer	Jedinečné ID vytvořené šablony. Tuto možnost použijte k vytvoření obálek z této šablony.
Name	template.templateName	string	Název šablony.
Description	template.templateDesc	string	Popis šablony.
Typ	template.templateType	string	Typ šablony.
Datum vytvoření	template.templateCreationDate	string	Datum vytvoření šablony.
Datum poslední aktualizace	template.templateLastUpdateDate	string	Datum poslední aktualizace šablony.
Upravitelný	template.editable	boolean	Určuje, zda lze šablonu upravit.
Počet stran	template.numberOfParties	integer	Počet přijímajících stran definovaných v šabloně.
Total Pages	template.totalPages	integer	Celkový počet stránek v dokumentu šablony
ID společnosti	template.companyId	integer	ID společnosti, do které tato šablona patří.
Sdílí se se všemi	template.shareAll	boolean	Určuje, jestli je tato šablona sdílena se všemi uživateli v účtu.
Vzor vlastního názvu	template.templateCustomName	string	Vzor vlastního názvu použitý u obálek vytvořených z této šablony.
Oprávnění stran	template.templatePartyPermissions	array of object	Seznamrolích
ID strany	template.templatePartyPermissions.template_party_id	integer	Jedinečné ID této položky strany šablony.
ID	template.templatePartyPermissions.templateId	integer	ID šablony, do které tato strana patří.
Permissions	template.templatePartyPermissions.templatePermissions	string	Podpisová oprávnění pro tuto stranu (např. FILL_FIELDS_AND_SIGN).
Podpisová objednávka	template.templatePartyPermissions.partySequence	integer	Podpisové pořadí pro tuto stranu.
Role strany	template.templatePartyPermissions.templatePartyRole	string	Název role přiřazený této straně v šabloně. Tuto možnost použijte při vytváření obálky ze šablony.
ID strany	template.templatePartyPermissions.partyId	integer	ID strany přiřazené k této roli, pokud je přiřazeno předem.
ID uživatele	template.templateCreatedBy.partyId	integer	Jedinečné ID uživatele.
Křestní jméno	template.templateCreatedBy.firstName	string	Jméno uživatele.
Příjmení	template.templateCreatedBy.lastName	string	Příjmení uživatele.
Email	template.templateCreatedBy.emailId	string	E-mailová adresa uživatele.
ID společnosti	template.templateCreatedBy.companyId	integer	ID společnosti, do které uživatel patří.
Role uživatele	template.templateCreatedBy.userRole	string	Role uživatele v rámci organizace.
Aktivní	template.templateCreatedBy.active	boolean	Určuje, jestli je účet uživatele aktivní.
ID uživatele	template.templateLastUpdatedBy.partyId	integer	Jedinečné ID uživatele.
Křestní jméno	template.templateLastUpdatedBy.firstName	string	Jméno uživatele.
Příjmení	template.templateLastUpdatedBy.lastName	string	Příjmení uživatele.
Email	template.templateLastUpdatedBy.emailId	string	E-mailová adresa uživatele.
ID společnosti	template.templateLastUpdatedBy.companyId	integer	ID společnosti, do které uživatel patří.
Role uživatele	template.templateLastUpdatedBy.userRole	string	Role uživatele v rámci organizace.
Aktivní	template.templateLastUpdatedBy.active	boolean	Určuje, jestli je účet uživatele aktivní.
Pole šablony	allfields	array of object	Seznam všech polí podpisu a formuláře definovaných v šabloně.
Pole ID	allfields.fieldTagId	integer	Jedinečný identifikátor pole.
ID šablony	allfields.templateId	integer	ID šablony, do které toto pole patří.
ID společnosti	allfields.companyId	integer	Toto pole patří účtu společnosti.
Typ pole	allfields.fieldType	string	Typ pole (např. signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Číslo stránky	allfields.documentPageNumber	integer	Číslo stránky dokumentu, do kterého je toto pole umístěné.
Zodpovědná strana	allfields.partyResponsible	integer	Pořadové číslo strany zodpovědné za vyplnění tohoto pole.
Party Sequence	allfields.partyResponsibleSequence	integer	Pořadí příslušné strany.
ID dokumentu pole	allfields.docFieldId	string	Identifikátor na úrovni dokumentu pro toto pole.
Je závislý	allfields.dependent	boolean	Určuje, jestli viditelnost tohoto pole závisí na hodnotě jiného pole.
Pořadí ovládacích prvků	allfields.tabOrder	integer	Pořadí ovládacích prvků pro navigaci mezi poli
Povinné	allfields.required	boolean	Určuje, zda musí být toto pole vyplněno před podepsání dokumentu.
Název vlastního pole	allfields.customFieldName	string	Vlastní název přiřazený k tomuto poli.
Sdílet vše	allfields.shareAll	boolean	Určuje, jestli je toto pole sdílené se všemi uživateli.
Povolit úpravy	allfields.allowEdit	boolean	Určuje, jestli toto pole může upravit příjemce.
Název textového pole	allfields.textfieldName	string	Popisek textového pole (lze použít, pokud je fieldType "textfield").
Hodnota	allfields.value	string	Předem vyplněná nebo zadaná hodnota pole.
Velikost písma	allfields.fontSize	integer	Velikost písma použitá pro text v tomto poli.
Barva písma	allfields.fontColor	string	Barva písma použitá pro text v tomto poli (např. #000000).
Jen pro čtení	allfields.readOnly	boolean	Určuje, zda je pole jen pro čtení a nelze ho upravit příjemcem.
Víceřádkový	allfields.multiLine	boolean	Určuje, jestli textové pole přijímá více řádků vstupu (platí, pokud je fieldType "textfield").
Omezení počtu znaků	allfields.characterLimit	integer	Maximální počet znaků povolených v poli (platí pro poleType je textfield).
Název pole kalendářního data	allfields.datefieldName	string	Popisek pole kalendářního data (lze použít, pokud je fieldType "datefield").
Formát data	allfields.dateFormat	string	Formát data používaný tímto polem (např. MM/DD/RRRR) (platí pro poleType datefield).
Název zaškrtávacího políčka	allfields.cbname	string	Popisek pole zaškrtávacího políčka (platí, pokud je fieldType 'checkboxfield').
Skupina zaškrtávacích zaškrtávacích políčka	allfields.cbgroup	string	Název skupiny pro toto zaškrtávací políčko (lze použít, pokud je fieldType 'checkboxfield').
Zkontrolováno	allfields.checked	boolean	Určuje, jestli je zaškrtávací políčko ve výchozím nastavení zaškrtnuté (platí, pokud je fieldType zaškrtávacím polím).
Název zabezpečeného pole	allfields.securedfieldName	string	Popisek zabezpečeného pole (platí pro poleType je "securedfield").
Znaky k zobrazení	allfields.charToDisplay	integer	Počet nemaskovaných znaků, které se mají zobrazit na konci hodnoty zabezpečeného pole (platí pro poleType je "securedfield").
ID podpisu	allfields.signatureId	string	ID podpisu použitého pro toto pole se znaménkem (platí pro poleType je signfield).
Počáteční obrázek	allfields.initialImage	string	Data obrázku pro iniciály použité u tohoto pole (platí pro poleType je "initialfield").
Název pole přílohy	allfields.attachmentfieldName	string	Název pole přílohy (lze použít, pokud je fieldType "attachmentfield").
Popis přílohy	allfields.attachmentfieldDescription	string	Popis toho, co připojit (platí, pokud je fieldType "attachmentfield").

Vytvoření šablony z Base64

ID operace:: CreateTemplatefromBase64

Vytvoří novou šablonu pomocí řetězce PDF s kódováním Base64. Tuto možnost použijte, když je soubor PDF již k dispozici jako řetězec Base64 ve vašem toku, například z SharePoint souboru nebo OneDrive dokumentu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název šablony	templateName	True	string	Název šablony. Musí končit příponou .pdf (např. onboarding.pdf).
Řetězec souboru Base64	base64FileString	True	string	Řetězec BASE64 PDF pro vytvoření šablony Při vytváření šablony by měla být veřejně přístupná.
Typ vstupu	inputType	True	string	Metoda zadávání dokumentu. Pro tuto akci je vždy nastavená hodnota base64.
Zpracování textových značek	processTextTags	True	boolean	Pokud je tato možnost povolená, Bude Foxit eSign prohledávat dokument textových značek a automaticky je převede na pole podpisu.
Zpracování polí Acro	processAcroFields	True	boolean	Pokud je tato možnost povolená, Foxit eSign prohledá dokument pro AcroFields a automaticky je převede na pole podpisu.
Sdílet vše	shareAll	True	boolean	Tuto šablonu můžete sdílet se všemi uživateli ve vašem účtu.
Počet stran	numberOfParties	True	integer	Počet příjemců pro tuto šablonu. Musí být menší než 20.
Barva motivu	themeColor		string	Hodnota barvy šablon stylů CSS pro přizpůsobení motivu relace vložené šablony (např. #42caf4).
Vytvořit e-mail	authorEmail		string	E-mailová adresa jiného uživatele v účtu, který se má nastavit jako autor této šablony.
Vytvoření vložené relace šablony	createEmbeddedTemplateSession		boolean	Pokud je nastavena hodnota true, vytvoří se vložená relace šablony, takže můžete otevřít editor šablon Foxit eSign přímo a přetáhnout pole do šablony.
Adresa URL pro přesměrování	redirectURL		string	Pokud je relace vytvořit vloženou šablonu pravdivá, adresa URL pro přesměrování uživatele po kliknutí na tlačítko Uložit a zavřít v vloženém editoru šablony.
Skrýt šablonu pro odeslání	hideSendTemplate		boolean	Pokud je true, tlačítko Odeslat je skryté v vloženém editoru šablon.
Oprava stran příjemců	fixRecipientParties		boolean	Pokud je pravda, strany příjemců, které již byly přidány, nelze v vloženém editoru šablon změnit.
Pole	Fields		object
oprávnění	permission	True	string
Sequence	sequence	True	integer	Jedinečné pořadové číslo pro tuto stranu od 1. Definuje podpisové pořadí, když je zapnuté pořadí přihlášení.
Role příjemce	partyRole	True	string	Role přiřazená této straně v šabloně.
Skrýt další akci	hideMoreAction		boolean	Pokud ano, tlačítko Další akce je v relaci vložené šablony skryté.
Skrýt sdílení se všemi	hideShareWithAll		boolean	Pokud ano, možnost Sdílet se všemi je v relaci vložené šablony skrytá.
Skrýt přidání strany	hideAddParty		boolean	Pokud je pravda, všechny možnosti přidání strany jsou v relaci vložené šablony skryté.
Tlačítko Skrýt mě	hideMeButton		boolean	Pokud je pravda, tlačítko Já ve stranách příjemců je skryté v vložené šabloně relace.
Tlačítko Skrýt ostatní	hideOthersButton		boolean	Pokud je pravda, tlačítko Ostatní na straně příjemce je skryté v vložené šabloně relace.
Skrýt jméno pole pro příjemce	hideFieldNameForRecipients		boolean	Pokud je pravda, názvy polí jsou příjemcům pro zadávání dat a upřesňující pole skryté.
Skrýt ohraničení zaškrtávacího políčka	hideCheckboxBorder		boolean	Pokud je hodnota true, ohraničení zaškrtávacího políčka jsou v prováděných dokumentech skryta.

Návraty

Name	Cesta	Typ	Description
Result	result	string	Určuje, jestli operace proběhla úspěšně (např. "success").
Message	message	string	Popis výsledku operace.
ID	template.templateId	integer	Jedinečné ID vytvořené šablony. Tuto možnost použijte k vytvoření obálek z této šablony.
Name	template.templateName	string	Název šablony.
Description	template.templateDesc	string	Popis šablony.
Typ	template.templateType	string	Typ šablony.
Datum vytvoření	template.templateCreationDate	string	Datum vytvoření šablony.
Datum poslední aktualizace	template.templateLastUpdateDate	string	Datum poslední aktualizace šablony.
Upravitelný	template.editable	boolean	Určuje, zda lze šablonu upravit.
Počet stran	template.numberOfParties	integer	Počet přijímajících stran definovaných v šabloně.
Total Pages	template.totalPages	integer	Celkový počet stránek v dokumentu šablony
ID společnosti	template.companyId	integer	ID společnosti, do které tato šablona patří.
Sdílí se se všemi	template.shareAll	boolean	Určuje, jestli je tato šablona sdílena se všemi uživateli v účtu.
Oprávnění stran	template.templatePartyPermissions	array of object	Seznamrolích
ID strany	template.templatePartyPermissions.template_party_id	integer	Jedinečné ID této položky strany šablony.
ID	template.templatePartyPermissions.templateId	integer	ID šablony, do které tato strana patří.
Permissions	template.templatePartyPermissions.templatePermissions	string	Podpisová oprávnění pro tuto stranu (např. FILL_FIELDS_AND_SIGN).
Podpisová objednávka	template.templatePartyPermissions.partySequence	integer	Podpisové pořadí pro tuto stranu.
Role strany	template.templatePartyPermissions.templatePartyRole	string	Název role přiřazený této straně v šabloně. Tuto možnost použijte při vytváření obálky ze šablony.
ID uživatele	template.templateCreatedBy.partyId	integer	Jedinečné ID uživatele.
Křestní jméno	template.templateCreatedBy.firstName	string	Jméno uživatele.
Příjmení	template.templateCreatedBy.lastName	string	Příjmení uživatele.
Email	template.templateCreatedBy.emailId	string	E-mailová adresa uživatele.
Pole šablony	allfields	array of object	Seznam všech polí podpisu a formuláře definovaných v šabloně.
Pole ID	allfields.fieldTagId	integer	Jedinečný identifikátor pole.
ID šablony	allfields.templateId	integer	ID šablony, do které toto pole patří.
ID společnosti	allfields.companyId	integer	Toto pole patří účtu společnosti.
Typ pole	allfields.fieldType	string	Typ pole (např. signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Číslo stránky	allfields.documentPageNumber	integer	Číslo stránky dokumentu, do kterého je toto pole umístěné.
Zodpovědná strana	allfields.partyResponsible	integer	Pořadové číslo strany zodpovědné za vyplnění tohoto pole.
Party Sequence	allfields.partyResponsibleSequence	integer	Pořadí příslušné strany.
ID dokumentu pole	allfields.docFieldId	string	Identifikátor na úrovni dokumentu pro toto pole.
Je závislý	allfields.dependent	boolean	Určuje, jestli viditelnost tohoto pole závisí na hodnotě jiného pole.
Pořadí ovládacích prvků	allfields.tabOrder	integer	Pořadí ovládacích prvků pro navigaci mezi poli
Povinné	allfields.required	boolean	Určuje, zda musí být toto pole vyplněno před podepsání dokumentu.
Název vlastního pole	allfields.customFieldName	string	Vlastní název přiřazený k tomuto poli.
Sdílet vše	allfields.shareAll	boolean	Určuje, jestli je toto pole sdílené se všemi uživateli.
Povolit úpravy	allfields.allowEdit	boolean	Určuje, jestli toto pole může upravit příjemce.
Název textového pole	allfields.textfieldName	string	Popisek textového pole (lze použít, pokud je fieldType "textfield").
Hodnota	allfields.value	string	Předem vyplněná nebo zadaná hodnota pole.
Velikost písma	allfields.fontSize	integer	Velikost písma použitá pro text v tomto poli.
Barva písma	allfields.fontColor	string	Barva písma použitá pro text v tomto poli (např. #000000).
Jen pro čtení	allfields.readOnly	boolean	Určuje, zda je pole jen pro čtení a nelze ho upravit příjemcem.
Víceřádkový	allfields.multiLine	boolean	Určuje, jestli textové pole přijímá více řádků vstupu (platí, pokud je fieldType "textfield").
Omezení počtu znaků	allfields.characterLimit	integer	Maximální počet znaků povolených v poli (platí pro poleType je textfield).
Název pole kalendářního data	allfields.datefieldName	string	Popisek pole kalendářního data (lze použít, pokud je fieldType "datefield").
Formát data	allfields.dateFormat	string	Formát data používaný tímto polem (např. MM/DD/RRRR) (platí pro poleType datefield).
Název zaškrtávacího políčka	allfields.cbname	string	Popisek pole zaškrtávacího políčka (platí, pokud je fieldType 'checkboxfield').
Skupina zaškrtávacích zaškrtávacích políčka	allfields.cbgroup	string	Název skupiny pro toto zaškrtávací políčko (lze použít, pokud je fieldType 'checkboxfield').
Zkontrolováno	allfields.checked	boolean	Určuje, jestli je zaškrtávací políčko ve výchozím nastavení zaškrtnuté (platí, pokud je fieldType zaškrtávacím polím).
Název zabezpečeného pole	allfields.securedfieldName	string	Popisek zabezpečeného pole (platí pro poleType je "securedfield").
Znaky k zobrazení	allfields.charToDisplay	integer	Počet nemaskovaných znaků, které se mají zobrazit na konci hodnoty zabezpečeného pole (platí pro poleType je "securedfield").
ID podpisu	allfields.signatureId	string	ID podpisu použitého pro toto pole se znaménkem (platí pro poleType je signfield).
Počáteční obrázek	allfields.initialImage	string	Data obrázku pro iniciály použité u tohoto pole (platí pro poleType je "initialfield").
Název pole přílohy	allfields.attachmentfieldName	string	Název pole přílohy (lze použít, pokud je fieldType "attachmentfield").
Popis přílohy	allfields.attachmentfieldDescription	string	Popis toho, co připojit (platí, pokud je fieldType "attachmentfield").

Výpis všech kanálů Webhooku

ID operace:: ListallWebhookChannels

Vrátí seznam všech kanálů webhooku nakonfigurovaných ve vašem účtu.

Návraty

Name	Cesta	Typ	Description
Result	result	string	Určuje, jestli žádost proběhla úspěšně.
Celkový počet kanálů	total_channel	integer	Celkový počet kanálů webhooku nakonfigurovaných v účtu
Kanály webhooků	templatesList	array of object	Seznam všech kanálů webhooků v účtu
ID kanálu	templatesList.channelId	integer	Jedinečný identifikátor kanálu webhooku.
ID společnosti	templatesList.companyId	integer	Účet společnosti, do které tento kanál patří.
Název kanálu	templatesList.channelName	string	Název kanálu webhooku
Adresa URL webhooku	templatesList.webhookUrl	string	Adresa URL, kterou Foxit eSign zavolá, když dojde k odběru události.
Tajný kód Webhooku	templatesList.webhookSecret	string	Tajný klíč použitý k ověření datových částí webhooku.
Datum vytvoření	templatesList.dateCreated	integer	Datum vytvoření kanálu v milisekundách unixu.
Datum aktualizace	templatesList.dateUpdated	integer	Datum poslední aktualizace kanálu v milisekundách unixu.
Úroveň webhooku	templatesList.webhookLevel	string	Rozsah kanálu webhooku Buď 'Account' (triggery pro všechny obálky) nebo "API App" (triggery pouze pro obálky vytvořené prostřednictvím rozhraní API).
Stav	templatesList.status	string	Aktuální stav kanálu. Buď "aktivní", nebo "neaktivní".
Obálka odeslána	templatesList.eventsSubscribedMap.folder_sent	boolean	Aktivuje se při odeslání obálky příjemcům.
Zobrazená obálka	templatesList.eventsSubscribedMap.folder_viewed	boolean	Aktivuje se, když příjemce otevře obálku.
Obálka podepsaná	templatesList.eventsSubscribedMap.folder_signed	boolean	Aktivuje se, když příjemce podepíše obálku.
Obálka zrušena	templatesList.eventsSubscribedMap.folder_cancelled	boolean	Aktivuje se při zrušení obálky.
Obálka se spustila	templatesList.eventsSubscribedMap.folder_executed	boolean	Aktivuje se, když všechny strany podepsaly a obálka se plně spustí.
Odstraněná obálka	templatesList.eventsSubscribedMap.folder_deleted	boolean	Aktivuje se při odstranění obálky.

Zrušit obálku

ID operace:: CancelEnvelope

Zruší odeslanou obálku. Příjemci už nebudou moct dokumenty podepsat.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	folderId	True	integer	ID obálky, která se má zrušit.
Důvod zrušení	reason_for_cancellation	True	string	Důvod zrušení této obálky. Zaznamenává se v historii aktivit obálky.

Návraty

Name	Cesta	Typ	Description
Result	result	string	Určuje, jestli žádost proběhla úspěšně.
ID zrušených obálek	folders cancelled	array of integer	Seznam ID obálek, které byly úspěšně zrušeny.

Získání historie aktivit obálky

ID operace:: GetEnvelopeActivityHistory

Načte úplný protokol aktivit obálky zobrazující všechny akce provedené příjemci a odesílatelem.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	folderId	True	integer	Jedinečný identifikátor obálky, jejíž historii aktivit chcete načíst.

Návraty

Name	Cesta	Typ	Description
Result	result	string	Určuje, jestli žádost proběhla úspěšně.
ID obálky	details.folderId	integer	Jedinečný identifikátor obálky.
Uzavřené dokumenty	details.enclosedDocuments	string	Název dokumentů uzavřených v obálce.
Příjemci	details.envelopeRecipients	string	Jména všech příjemců na obálce
Author	details.author	string	Jméno uživatele, který obálku vytvořil.
Stav	details.status	string	Aktuální stav obálky (např. SHARED, EXECUTED, CANCELLED).
Datum poslední aktivity	details.latestActivityDate	string	Datum a čas poslední aktivity na obálce.
Datum vytvoření	details.dateCreated	string	Datum a čas vytvoření obálky.
Datum odeslání	details.dateSent	string	Datum a čas odeslání obálky příjemcům.
Activities	details.activities	array of object	Chronologický seznam všech akcí provedených na této obálce.
Activity	details.activities.activity	string	Popis akce, ke které došlo, je čitelný pro člověka.
Action	details.activities.action	string	Typ provedené akce (např. Vytvoření, Odeslání pozvánky, Otevření, Zobrazení, Podepsáno).
User	details.activities.user	string	Jméno uživatele, který akci provedl.
Stav obálky	details.activities.folderStatus	string	Stav obálky v době, kdy k této akci došlo.
Time	details.activities.time	string	Datum a čas, kdy došlo k akci.
Source	details.activities.source	string	Zdroj, ze kterého byla akce provedena (např. web).
IP adresa	details.activities.ipAddress	string	IP adresa, ze které byla akce provedena, pokud je k dispozici.

Získání historie odstraněných obálek

ID operace:: GetDeletedEnvelopeHistory

Načte historii obálek, které byly odstraněny nebo přesunuty do koše.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	folderId	True	string	Jedinečný identifikátor obálky, jejíž historii odstranění chcete načíst.

Návraty

Name	Cesta	Typ	Description
Result	result	string	Určuje, jestli žádost proběhla úspěšně.
Odstraněné informace o obálce	Deleted Folder Log Info	array of object	Souhrnné informace o odstraněné obálce
ID obálky	Deleted Folder Log Info.folderId	integer	Jedinečný identifikátor odstraněné obálky.
Název obálky	Deleted Folder Log Info.folderName	string	Název odstraněné obálky.
Název dokumentu	Deleted Folder Log Info.documentName	string	Název dokumentu v odstraněné obálce.
ID dokumentu	Deleted Folder Log Info.documentId	string	Jedinečný identifikátor dokumentu v odstraněné obálce.
Datum odstranění	Deleted Folder Log Info.deletionDate	integer	Datum a čas odstranění obálky v milisekundách unixu.
Odstraněno uživatelem	Deleted Folder Log Info.deletedBy	string	Jméno uživatele, který obálku odstranil.
Historie protokolu odstranění	Deleted Folder Log History	array of object	Podrobný protokol všech akcí odstranění provedených na obálce.
Provedl(a)	Deleted Folder Log History.partiesName	string	Jméno uživatele, který provedl krok odstranění.
Source	Deleted Folder Log History.source	string	Zdroj, ze kterého bylo odstranění zahájeno (např. web, rozhraní API).
Event	Deleted Folder Log History.event	string	Konkrétní akce odstranění (např. Odstranit složku, Odstranit všechny strany ze složky)

Získání ID obálky

ID operace:: GetEnvelopeIds

Vrátí seznam ID obálek filtrovaných podle stavu. Tuto možnost použijte k vyhledání obálek v určitém stavu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Datum od	dateFrom	True	string	Začátek rozsahu dat vytvoření obálky Akceptovaný formát: RRRR-MM-DD.
Datum do	dateTo	True	string	Konec rozsahu dat vytvoření obálky Akceptovaný formát: RRRR-MM-DD. Hodnota dateTo musí být do 6 měsíců od hodnoty dateFrom.
Stav	status		string	Filtrujte obálky podle stavu. Přijaté hodnoty: EXECUTED, SHARED, DRAFT, PARTIALLY SIGNED, CANCELLED, EXPIRED, DELETED. Pokud je tento parametr vynechán, vrátí se obálky s jakýmkoli stavem.

Návraty

Name	Cesta	Typ	Description
Result	result	string	Určuje, jestli žádost proběhla úspěšně.
Message	message	string	Souhrnná zpráva označující, kolik ID obálek bylo vráceno.
ID obálek	allFolderIds	array of integer	Seznam ID obálek odpovídající kritériím filtru. Pomocí těchto ID s informacemi o obálce získejte úplné informace o obálce.

Získání podrobností kanálu Webhooku

ID operace:: GetWebhookChannelDetails

Načte podrobnosti o konkrétním kanálu webhooku.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID kanálu	channelId	True	string	Jedinečný identifikátor kanálu webhooku, který se má načíst.

Návraty

Name	Cesta	Typ	Description
Result	result	string	Určuje, jestli žádost proběhla úspěšně.
ID	channel.channelId	integer	Jedinečný identifikátor kanálu webhooku.
ID společnosti	channel.companyId	integer	Účet společnosti, do které tento kanál patří.
Name	channel.channelName	string	Název kanálu webhooku.
Adresa URL webhooku	channel.webhookUrl	string	Adresa URL, kterou Foxit eSign zavolá, když dojde k odběru události.
Tajný kód Webhooku	channel.webhookSecret	string	Tajný klíč použitý k ověření datových částí webhooku.
Datum vytvoření	channel.dateCreated	integer	Datum vytvoření kanálu v milisekundách unixu.
Datum aktualizace	channel.dateUpdated	integer	Datum poslední aktualizace kanálu v milisekundách unixu.
Úroveň webhooku	channel.webhookLevel	string	Rozsah kanálu webhooku Buď 'Account' (triggery pro všechny obálky) nebo "API App" (triggery pouze pro obálky vytvořené prostřednictvím rozhraní API).
Stav	channel.status	string	Aktuální stav kanálu. Buď "aktivní", nebo "neaktivní".
Obálka odeslána	channel.eventsSubscribedMap.folder_sent	boolean	Aktivuje se při odeslání obálky příjemcům.
Zobrazená obálka	channel.eventsSubscribedMap.folder_viewed	boolean	Aktivuje se, když příjemce otevře obálku.
Obálka podepsaná	channel.eventsSubscribedMap.folder_signed	boolean	Aktivuje se, když příjemce podepíše obálku.
Obálka zrušena	channel.eventsSubscribedMap.folder_cancelled	boolean	Aktivuje se při zrušení obálky.
Obálka se spustila	channel.eventsSubscribedMap.folder_executed	boolean	Aktivuje se, když všechny strany podepsaly a obálka se plně spustí.
Odstraněná obálka	channel.eventsSubscribedMap.folder_deleted	boolean	Aktivuje se při odstranění obálky.

Získání podrobností o e-mailové skupině

ID operace:: GetEmailGroupDetails

Načte podrobnosti o existující e-mailové skupině.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Názvy e-mailových skupin	emailGroupNames	True	array of string	Pole názvů e-mailových skupin sloužících k identifikaci skupin

Návraty

Name	Cesta	Typ	Description
E-mailové skupiny	allEmailGroups	array of object	Seznam e-mailových skupin odpovídajících požadovaným názvům skupin
ID skupiny	allEmailGroups.groupId	integer	Jedinečný identifikátor e-mailové skupiny.
Název skupiny	allEmailGroups.groupName	string	Název e-mailové skupiny.
Popis skupiny	allEmailGroups.groupDesc	string	Popis e-mailové skupiny
Datum vytvoření	allEmailGroups.dateCreated	integer	Datum vytvoření e-mailové skupiny v milisekundách unixu.
ID společnosti	allEmailGroups.companyId	integer	Firemní účet, do které patří tato e-mailová skupina.
Parties	allEmailGroups.parties	array of object	Seznam příjemců v této e-mailové skupině
Křestní jméno	allEmailGroups.parties.firstName	string	Jméno příjemce.
Příjmení	allEmailGroups.parties.lastName	string	Příjmení příjemce.
Email	allEmailGroups.parties.emailId	string	E-mailová adresa příjemce.

Získání podrobností o obálce

ID operace:: GetEnvelopeDetails

Načte úplné podrobnosti obálky, včetně jejího stavu, příjemců a dokumentů.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID obálky	folderId	True	integer	Jedinečný identifikátor obálky, která se má načíst.
Token přístupu	access_token		string	Přístupový token OAuth 2.0 pro ověřování.

Návraty

Name	Cesta	Typ	Description
Result	result	string	Určuje, jestli operace proběhla úspěšně (např. "success").
ID	folder.folderId	integer	Jedinečné ID obálky.
Name	folder.folderName	string	Název obálky.
ID autora	folder.folderAuthorId	integer	Jedinečné ID uživatele, který obálku vytvořil.
Jméno autora	folder.folderAuthorFirstName	string	Jméno autora obálky.
Příjmení autora	folder.folderAuthorLastName	string	Příjmení tvůrce obálky.
Vytvořit e-mail	folder.folderAuthorEmail	string	E-mailová adresa tvůrce obálky.
Role autora	folder.folderAuthorRole	string	Role účtu tvůrce obálky.
ID společnosti	folder.folderCompanyId	integer	Jedinečné ID společnosti, do které obálka patří.
Datum vytvoření	folder.folderCreationDate	integer	Datum a čas vytvoření obálky v milisekundách unixu.
Datum odeslání	folder.folderSentDate	integer	Datum a čas odeslání obálky příjemcům v milisekundách unixu. Hodnota Null, pokud ještě nebyla odeslána.
Stav	folder.folderStatus	string	Aktuální stav obálky (např. SHARED, EXECUTED, DRAFT, CANCELLED).
ID dokumentů	folder.folderDocumentIds	array of integer	Seznam ID dokumentů obsažených v této obálce.
Documents	folder.documentsList	array of object	Podrobnosti o každém dokumentu, který je součástí obálky.
ID dokumentu	folder.documentsList.documentId	integer	Jedinečný identifikátor dokumentu.
ID smlouvy	folder.documentsList.contractId	integer	Jedinečný identifikátor smlouvy přidružené k tomuto dokumentu.
ID společnosti	folder.documentsList.companyId	integer	Jedinečné ID společnosti, do které tento dokument patří.
Vytvořeno kým	folder.documentsList.contractCreatedBy	integer	ID uživatele osoby, která smlouvu vytvořila.
Vytvořeno dne	folder.documentsList.contractCreatedOn	integer	Datum vytvoření kontraktu v milisekundách unixu.
Typ smlouvy	folder.documentsList.contractType	string	Typ nebo kategorie smlouvy.
Stav dokumentu	folder.documentsList.contractStatus	string	Aktuální stav podepisování dokumentu (např. WAITING_FOR_SIGNATURE, EXECUTED).
Upravitelný	folder.documentsList.editable	boolean	Určuje, zda lze dokument upravit.
ID verze	folder.documentsList.contractVersionId	integer	Jedinečné ID aktuální verze dokumentu.
Název verze	folder.documentsList.contractVersionName	string	Název aktuální verze dokumentu.
Popis verze	folder.documentsList.contractVersionDesc	string	Popis aktuální verze dokumentu
Verze vytvořená uživatelem	folder.documentsList.versionCreatedby	integer	ID uživatele osoby, která vytvořila tuto verzi dokumentu.
Verze vytvořená dne	folder.documentsList.versionCreatedOn	integer	Datum vytvoření této verze dokumentu v milisekundách unixu.
Číslo verze	folder.documentsList.contractVersionNumber	integer	Číslo verze dokumentu.
Příjemci	folder.folderRecipientParties	array of object	Seznam příjemců pro tuto obálku, včetně jejich podpisového stavu a přístupových odkazů.
ID příjemce	folder.folderRecipientParties.partyId	integer	Jedinečný identifikátor příjemce.
ID příjemce	folder.folderRecipientParties.partyDetails.partyId	integer	Jedinečný identifikátor příjemce.
Křestní jméno	folder.folderRecipientParties.partyDetails.firstName	string	Jméno příjemce.
Příjmení	folder.folderRecipientParties.partyDetails.lastName	string	Příjmení příjemce.
Email	folder.folderRecipientParties.partyDetails.emailId	string	E-mailová adresa příjemce.
Address	folder.folderRecipientParties.partyDetails.address	string	Adresa příjemce.
Datum vytvoření účtu	folder.folderRecipientParties.partyDetails.dateCreated	integer	Datum vytvoření účtu příjemce v milisekundách unixu.
Permissions	folder.folderRecipientParties.contractPermissions	string	Podpisová oprávnění udělená tomuto příjemci (např. FILL_FIELDS_AND_SIGN).
Podpisová objednávka	folder.folderRecipientParties.partySequence	integer	Pozice tohoto příjemce v podpisové objednávce.
Pořadí pracovních postupů	folder.folderRecipientParties.workflowSignSequence	integer	Číslo sekvence podepisování pracovního postupu pro tohoto příjemce.
ID obálky	folder.folderRecipientParties.envelopeId	integer	ID obálky, do které tento příjemce patří.
Režim sdílení	folder.folderRecipientParties.sharingMode	string	Metoda používaná ke sdílení dokumentu s tímto příjemcem (např. e-mailem).
Podpisová adresa URL	folder.folderRecipientParties.folderAccessURL	string	Jedinečná podpisová adresa URL tohoto příjemce. Hodnota Null, pokud už byla obálka dokončena nebo zrušena.
Režim zabezpečení	folder.folderRecipientParties.securityMode	string	Režim zabezpečení použitý pro přístup tohoto příjemce.
Další komentáře	folder.folderRecipientParties.extraComments	string	Všechny další komentáře zahrnuté v podpisové pozvánce pro tohoto příjemce.
Adresa URL pro autory přístupu	folder.folderAccessURLForAuthor	string	Adresa URL pro autora obálky pro přístup k dokumentu. Hodnota null, pokud nejde použít.
Hromadné ID	folder.bulkId	integer	ID dávky hromadného odeslání, do které tato obálka patří, pokud existuje.
Vynucení pořadí podpisu	folder.enforceSignWorkflow	boolean	Určuje, jestli se příjemci musí přihlásit k zadané objednávce.
Aktuální krok pracovního postupu	folder.currentWorkflowStep	integer	Aktuální krok v pracovním postupu podepisování.
Zdroj transakcí	folder.transactionSource	string	Zdroj, který inicioval tuto obálku transakce.
Upravitelný	folder.editable	boolean	Určuje, jestli je možné obálku i nadále upravovat.
podepisování In-Person	folder.inPersonSignable	boolean	Určuje, zda lze obálku podepsat osobně.
Přepsání připomenutí	folder.overrideAccountReminders	boolean	Určuje, jestli se pro tuto obálku přepíše nastavení připomenutí na úrovni účtu.
ID	folder.envelopeId	integer	Jedinečné ID obálky. Stejná hodnota jako ID obálky (folderId).
Name	folder.envelopeName	string	Název obálky. Stejná hodnota jako Název obálky (folderName).
ID původce	folder.envelopeOriginatorId	integer	ID uživatele osoby, která obálku vytvořila.
ID společnosti	folder.envelopeCompanyId	integer	ID společnosti, do které obálka patří.
Date	folder.envelopeDate	integer	Datum a čas vytvoření obálky v milisekundách unixu.
Sdílené datum	folder.envelopeSharedDate	integer	Datum a čas sdílení obálky s příjemci v milisekundách unixu. Hodnota Null, pokud ještě není sdílena.
Stav	folder.envelopeStatus	string	Aktuální stav obálky. Stejná hodnota jako Stav obálky (folderStatus).
ID kontraktů	folder.envelopeContractIds	array of integer	Seznam ID kontraktů přidružených k této obálce.
Oprávnění stran	folder.envelopePartyPermissions	array of object	Seznam příjemců a jejich podpisová oprávnění. Stejná struktura jako Příjemci.
ID příjemce	folder.envelopePartyPermissions.partyId	integer	Jedinečný identifikátor příjemce.
Křestní jméno	folder.envelopePartyPermissions.partyDetails.firstName	string	Jméno příjemce.
Příjmení	folder.envelopePartyPermissions.partyDetails.lastName	string	Příjmení příjemce.
Email	folder.envelopePartyPermissions.partyDetails.emailId	string	E-mailová adresa příjemce.
Permissions	folder.envelopePartyPermissions.contractPermissions	string	Podpisová oprávnění pro tohoto příjemce.
Podpisová objednávka	folder.envelopePartyPermissions.partySequence	integer	Pozice tohoto příjemce v podpisové objednávce.
Podpisová adresa URL	folder.envelopePartyPermissions.folderAccessURL	string	Jedinečná podpisová adresa URL tohoto příjemce.
Všechna pole	allFields	array of object	Seznam všech polí podpisu a formuláře umístěných v dokumentech obálky.
Pole ID	allFields.fieldTagId	integer	Jedinečný identifikátor pole.
ID dokumentu	allFields.contractId	integer	ID dokumentu, do které toto pole patří.
ID verze	allFields.versionId	integer	ID verze dokumentu, do které toto pole patří.
Typ pole	allFields.fieldType	string	Typ pole (např. signfield, textfield, datefield, checkboxfield, dropdownfield, initialfield).
Číslo stránky	allFields.documentPageNumber	integer	Číslo stránky, kde je toto pole umístěné.
ID dokumentu pole	allFields.docFieldId	string	Identifikátor na úrovni dokumentu pro toto pole.
Zodpovědná strana	allFields.partyResponsible	integer	ID strany zodpovědné za vyplnění tohoto pole.
Je závislý	allFields.dependent	boolean	Určuje, jestli viditelnost tohoto pole závisí na hodnotě jiného pole.
Povinné	allFields.required	boolean	Určuje, zda musí být toto pole vyplněno před odesláním dokumentu.
Hodnota pole	allFields.value	string	Aktuální hodnota pole, pokud je vyplněná.
Hodnoty polí	allFieldsNameValue	array of object	Zjednodušený seznam všech názvů polí a jejich aktuálních hodnot. Slouží ke čtení vyplněných dat polí ze podepsané obálky.
Pole ID	allFieldsNameValue.fieldId	integer	Jedinečný identifikátor pole.
ID dokumentu	allFieldsNameValue.documentId	integer	ID dokumentu, do které toto pole patří.
ID verze	allFieldsNameValue.documentVersionId	integer	ID verze dokumentu, do které toto pole patří.
Typ pole	allFieldsNameValue.fieldType	string	Typ pole (například textové pole, signfield, datum, zaškrtávací pole, rozevírací pole).
Název pole	allFieldsNameValue.name	string	Popisek nebo název pole definovaného v šabloně
Hodnota pole	allFieldsNameValue.value	string	Hodnota zadaná nebo vybraná pro toto pole.
Historie obálek	Folder History	array of object	Záznam auditu všech akcí provedených na této obálce v chronologickém pořadí.
Křestní jméno	Folder History.firstName	string	Jméno osoby, která akci provedla.
Příjmení	Folder History.lastName	string	Příjmení osoby, která akci provedla.
Email	Folder History.email	string	E-mailová adresa osoby, která akci provedla.
ID obálky	Folder History.envelopeId	integer	ID obálky, na které byla akce provedena.
Date	Folder History.dateChanged	integer	Datum a čas, kdy došlo k akci v milisekundách unixu.
ID strany	Folder History.changeDoneByParty	integer	ID strany osoby, která akci provedla.
Action	Folder History.action	string	Akce provedená na obálce (např. Vytvořeno, PozvatSentTo, InviteAccepted, Signed, Executed).

Získání podrobností o šabloně

ID operace:: GetTemplateDetails

Načte úplné podrobnosti konkrétní šablony včetně polí a příjemců.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID šablony	templateId	True	string	Jedinečný identifikátor šablony, který se má načíst.

Návraty

Name	Cesta	Typ	Description
Result	result	string	Určuje, jestli žádost proběhla úspěšně.
ID	template.templateId	integer	Jedinečný identifikátor šablony.
Name	template.templateName	string	Název šablony.
Description	template.templateDesc	string	Popis šablony.
Typ	template.templateType	string	Typ šablony.
Datum vytvoření	template.templateCreationDate	integer	Datum vytvoření šablony v milisekundách unixu.
Datum poslední aktualizace	template.templateLastUpdateDate	integer	Datum poslední aktualizace šablony v milisekundách unixu.
Upravitelný	template.editable	boolean	Určuje, zda lze šablonu upravit.
Počet stran	template.numberOfParties	integer	Počet podpisových stran definovaných v šabloně.
Total Pages	template.totalPages	integer	Celkový počet stránek v dokumentu šablony
ID společnosti	template.companyId	integer	Firemní účet, do které šablona patří.
Sdílet se všemi	template.shareAll	boolean	Určuje, jestli je šablona sdílena se všemi uživateli v účtu.
Vzor vlastního názvu	template.templateCustomName	string	Vzor vlastního názvu použitý u obálek vytvořených z této šablony.
Oprávnění stran	template.templatePartyPermissions	array of object	Seznam rolí příjemců a jejich podpisových oprávnění definovaných v této šabloně.
ID strany	template.templatePartyPermissions.template_party_id	integer	Jedinečné ID této položky strany šablony.
ID	template.templatePartyPermissions.templateId	integer	ID šablony, do které tato strana patří.
Permissions	template.templatePartyPermissions.templatePermissions	string	Podpisová oprávnění pro tuto stranu (např. FILL_FIELDS_AND_SIGN).
Podpisová objednávka	template.templatePartyPermissions.partySequence	integer	Podpisové pořadí pro tuto stranu.
Role strany	template.templatePartyPermissions.templatePartyRole	string	Název role přiřazený této straně. Tuto hodnotu použijte při vytváření obálky z této šablony.
ID strany	template.templatePartyPermissions.partyId	integer	ID strany přiřazené k této roli, pokud je přiřazeno předem.
ID strany	template.templateCreatedBy.partyId	integer	Jedinečný identifikátor uživatele.
Křestní jméno	template.templateCreatedBy.firstName	string	Jméno uživatele.
Příjmení	template.templateCreatedBy.lastName	string	Příjmení uživatele.
Email	template.templateCreatedBy.emailId	string	E-mailová adresa uživatele
Oddělení	template.templateCreatedBy.department	string	Oddělení uživatele.
Title	template.templateCreatedBy.title	string	Pracovní pozice uživatele.
Aktivní	template.templateCreatedBy.active	boolean	Označuje, jestli je uživatelský účet aktivní.
ID strany	template.templateLastUpdatedBy.partyId	integer	Jedinečný identifikátor uživatele.
Křestní jméno	template.templateLastUpdatedBy.firstName	string	Jméno uživatele.
Příjmení	template.templateLastUpdatedBy.lastName	string	Příjmení uživatele.
Email	template.templateLastUpdatedBy.emailId	string	E-mailová adresa uživatele
Oddělení	template.templateLastUpdatedBy.department	string	Oddělení uživatele.
Title	template.templateLastUpdatedBy.title	string	Pracovní pozice uživatele.
Aktivní	template.templateLastUpdatedBy.active	boolean	Označuje, jestli je uživatelský účet aktivní.
Všechna pole	allfields	array of object	Seznam všech polí definovaných v této šabloně
ID značky pole	allfields.fieldTagId	integer	Jedinečný identifikátor pole.
ID šablony	allfields.templateId	integer	ID šablony, do které toto pole patří.
ID společnosti	allfields.companyId	integer	Toto pole patří účtu společnosti.
Typ pole	allfields.fieldType	string	Typ pole (např. signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Číslo stránky	allfields.documentPageNumber	integer	Číslo stránky dokumentu, do kterého je toto pole umístěné.
Zodpovědná strana	allfields.partyResponsible	integer	Pořadové číslo strany zodpovědné za dokončení tohoto pole.
Party Sequence	allfields.partyResponsibleSequence	integer	Pořadí příslušné strany.
ID pole doc	allfields.docFieldId	string	Identifikátor tohoto pole v dokumentu.
Závislý	allfields.dependent	boolean	Určuje, jestli viditelnost tohoto pole závisí na hodnotě jiného pole.
Pořadí ovládacích prvků	allfields.tabOrder	integer	Pořadí ovládacích prvků pro navigaci mezi poli
Povinné	allfields.required	boolean	Určuje, zda musí být toto pole dokončeno před podepsání dokumentu.
Název vlastního pole	allfields.customFieldName	string	Vlastní název přiřazený k tomuto poli.
Sdílet vše	allfields.shareAll	boolean	Určuje, jestli je toto pole sdílené se všemi uživateli.
Povolit úpravy	allfields.allowEdit	boolean	Určuje, jestli toto pole může upravit příjemce.
Název textového pole	allfields.textfieldName	string	Popisek textového pole (lze použít, pokud je fieldType "textfield").
Hodnota	allfields.value	string	Předem vyplněná nebo zadaná hodnota pole.
Velikost písma	allfields.fontSize	integer	Velikost písma použitá pro text v tomto poli.
Barva písma	allfields.fontColor	string	Barva písma použitá pro text v tomto poli (např. #000000).
Jen pro čtení	allfields.readOnly	boolean	Určuje, zda je pole jen pro čtení a nelze ho upravit příjemcem.
Víceřádkový	allfields.multiLine	boolean	Určuje, jestli textové pole přijímá více řádků vstupu (platí, pokud je fieldType "textfield").
Omezení počtu znaků	allfields.characterLimit	integer	Maximální počet znaků povolených v poli (platí pro poleType je textfield).
Název pole kalendářního data	allfields.datefieldName	string	Popisek pole kalendářního data (lze použít, pokud je fieldType "datefield").
Formát data	allfields.dateFormat	string	Formát data používaný tímto polem (např. MM/DD/RRRR) (platí pro poleType datefield).
Název zaškrtávacího políčka	allfields.cbname	string	Popisek pole zaškrtávacího políčka (platí, pokud je fieldType 'checkboxfield').
Skupina zaškrtávacích zaškrtávacích políčka	allfields.cbgroup	string	Název skupiny pro toto zaškrtávací políčko, který se používá při propojení více zaškrtávacích políček (lze použít, pokud je fieldType 'checkboxfield').
Zkontrolováno	allfields.checked	boolean	Určuje, jestli je zaškrtávací políčko ve výchozím nastavení zaškrtnuté (platí, pokud je fieldType zaškrtávacím polím).
Název zabezpečeného pole	allfields.securedfieldName	string	Popisek zabezpečeného pole (platí pro poleType je "securedfield").
Znaky k zobrazení	allfields.charToDisplay	integer	Počet nemaskovaných znaků, které se mají zobrazit na konci hodnoty zabezpečeného pole (platí pro poleType je "securedfield").
ID podpisu	allfields.signatureId	string	ID podpisu použitého pro toto pole se znaménkem (platí pro poleType je signfield).
Počáteční obrázek	allfields.initialImage	string	Data obrázku pro iniciály použité u tohoto pole (platí pro poleType je "initialfield").
Název pole přílohy	allfields.attachmentfieldName	string	Název pole přílohy (lze použít, pokud je fieldType "attachmentfield").
Popis přílohy	allfields.attachmentfieldDescription	string	Popis toho, co připojit (platí, pokud je fieldType "attachmentfield").

Získání seznamu všech šablon

ID operace:: GetalistofallTemplates

Vrátí seznam všech šablon dostupných ve vašem účtu.

Návraty

Name	Cesta	Typ	Description
Result	result	string	Určuje, jestli žádost proběhla úspěšně.
Total Templates	total_templates	integer	Celkový počet šablon ve vašem účtu.
Seznam šablon	templatesList	array of object	Seznam všech šablon dostupných v účtu
ID šablony	templatesList.templateId	integer	Jedinečný identifikátor šablony. Pomocí tohoto ID vytvořte obálku ze šablony k odeslání šablony pro podepsání.
Název šablony	templatesList.templateName	string	Název šablony.
Popis šablony	templatesList.templateDesc	string	Popis šablony.
Typ šablony	templatesList.templateType	string	Typ nebo kategorie šablony.
Datum vytvoření	templatesList.templateCreationDate	integer	Datum vytvoření šablony v milisekundách unixu.
Datum poslední aktualizace	templatesList.templateLastUpdateDate	integer	Datum poslední aktualizace šablony v milisekundách unixu.
Upravitelný	templatesList.editable	boolean	Určuje, zda lze šablonu upravit.
Počet stran	templatesList.numberOfParties	integer	Počet podpisových stran definovaných v šabloně.
ID společnosti	templatesList.companyId	integer	Firemní účet, do které šablona patří.
Sdílet se všemi	templatesList.shareAll	boolean	Určuje, jestli je šablona sdílena se všemi uživateli v účtu.
ID strany	templatesList.templateCreatedBy.partyId	integer	Jedinečný identifikátor uživatele.
Křestní jméno	templatesList.templateCreatedBy.firstName	string	Jméno uživatele.
Příjmení	templatesList.templateCreatedBy.lastName	string	Příjmení uživatele.
Email	templatesList.templateCreatedBy.emailId	string	E-mailová adresa uživatele
ID strany	templatesList.templateLastUpdatedBy.partyId	integer	Jedinečný identifikátor uživatele.
Křestní jméno	templatesList.templateLastUpdatedBy.firstName	string	Jméno uživatele.
Příjmení	templatesList.templateLastUpdatedBy.lastName	string	Příjmení uživatele.
Email	templatesList.templateLastUpdatedBy.emailId	string	E-mailová adresa uživatele

Získání šablon podle ID šablon

ID operace:: GetTemplatesbyTemplateIds

Načte podrobnosti o jedné nebo více šablonách podle jejich ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID šablony	templateIds	True	array of integer	Pole ID šablony, která se má načíst.

Návraty

Name	Cesta	Typ	Description
Result	result	string	Určuje, jestli žádost proběhla úspěšně.
Total Templates	total_templates	integer	Celkový počet vrácených šablon.
Seznam šablon	templateIdList	object	Mapa dat šablony s klíči podle ID šablony Každá položka obsahuje podrobnosti šablony a její pole.

Aktivační události

Když je obálka podepsaná	Aktivuje se, když příjemce podepíše obálku.
Při odeslání obálky	Aktivuje se při odeslání obálky příjemcům. Tato událost se aktivuje jenom v případě, že je úroveň Webhooku nastavená na Účet.
Při odstranění obálky	Aktivuje se při odstranění obálky.
Při zobrazení obálky	Aktivuje se, když se příjemce otevře a zobrazí obálku.
Při zrušení obálky	Aktivuje se, když příjemce nebo odesílatel zruší obálku.
Při úplném spuštění obálky	Aktivuje se, když všichni příjemci podepsali a obálka se plně spustí.

Když je obálka podepsaná

ID operace:: TriggerEnvelopeSigned

Aktivuje se, když příjemce podepíše obálku.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název kanálu	channelName	True	string	Název pro identifikaci tohoto předplatného webhooku ve vašem účtu.
Úroveň webhooku	webhookLevel	True	string	Účet: aktivuje se pro všechny obálky (web a rozhraní API). Aplikace API: Aktivuje se pouze pro obálky vytvořené prostřednictvím rozhraní API.
Tajný kód Webhooku	webhookSecret		string	Optional. Foxit eSign podepíše každou datovou část webhooku pomocí HMAC-SHA-256 pomocí tohoto tajného kódu pro ověření.

Návraty

Data události přijatá z eSign Foxit při spuštění události webhooku.

WebhookEventPayload: WebhookEventPayload

Při odeslání obálky

ID operace:: TriggerEnvelopeSent

Aktivuje se při odeslání obálky příjemcům. Tato událost se aktivuje jenom v případě, že je úroveň Webhooku nastavená na Účet.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název kanálu	channelName	True	string	Název pro identifikaci tohoto předplatného webhooku ve vašem účtu.
Úroveň webhooku	webhookLevel	True	string	Účet: Aktivuje se pro obálky odeslané přes web nebo rozhraní API. Aplikace API: Aktivuje se pouze pro obálky vytvořené prostřednictvím rozhraní API. Událost folder_sent se aktivuje jenom na úrovni účtu.
Tajný kód Webhooku	webhookSecret		string	Optional. Foxit eSign podepíše každou datovou část webhooku pomocí HMAC-SHA-256 pomocí tohoto tajného kódu pro ověření.

Návraty

Data události přijatá z eSign Foxit při spuštění události webhooku.

WebhookEventPayload: WebhookEventPayload

Při odstranění obálky

ID operace:: TriggerEnvelopeDeleted

Aktivuje se při odstranění obálky.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název kanálu	channelName	True	string	Název pro identifikaci tohoto předplatného webhooku ve vašem účtu.
Úroveň webhooku	webhookLevel	True	string	Účet: aktivuje se pro všechny obálky (web a rozhraní API). Aplikace API: Aktivuje se pouze pro obálky vytvořené prostřednictvím rozhraní API.
Tajný kód Webhooku	webhookSecret		string	Optional. Foxit eSign podepíše každou datovou část webhooku pomocí HMAC-SHA-256 pomocí tohoto tajného kódu pro ověření.

Návraty

Data události přijatá z eSign Foxit při spuštění události webhooku.

WebhookEventPayload: WebhookEventPayload

Při zobrazení obálky

ID operace:: TriggerEnvelopeViewed

Aktivuje se, když se příjemce otevře a zobrazí obálku.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název kanálu	channelName	True	string	Název pro identifikaci tohoto předplatného webhooku ve vašem účtu.
Úroveň webhooku	webhookLevel	True	string	Účet: aktivuje se pro všechny obálky (web a rozhraní API). Aplikace API: Aktivuje se pouze pro obálky vytvořené prostřednictvím rozhraní API.
Tajný kód Webhooku	webhookSecret		string	Optional. Foxit eSign podepíše každou datovou část webhooku pomocí HMAC-SHA-256 pomocí tohoto tajného kódu pro ověření.

Návraty

Data události přijatá z eSign Foxit při spuštění události webhooku.

WebhookEventPayload: WebhookEventPayload

Při zrušení obálky

ID operace:: TriggerEnvelopeCancelled

Aktivuje se, když příjemce nebo odesílatel zruší obálku.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název kanálu	channelName	True	string	Název pro identifikaci tohoto předplatného webhooku ve vašem účtu.
Úroveň webhooku	webhookLevel	True	string	Účet: aktivuje se pro všechny obálky (web a rozhraní API). Aplikace API: Aktivuje se pouze pro obálky vytvořené prostřednictvím rozhraní API.
Tajný kód Webhooku	webhookSecret		string	Optional. Foxit eSign podepíše každou datovou část webhooku pomocí HMAC-SHA-256 pomocí tohoto tajného kódu pro ověření.

Návraty

Data události přijatá z eSign Foxit při spuštění události webhooku.

WebhookEventPayload: WebhookEventPayload

Při úplném spuštění obálky

ID operace:: TriggerEnvelopeExecuted

Aktivuje se, když všichni příjemci podepsali a obálka se plně spustí.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název kanálu	channelName	True	string	Název pro identifikaci tohoto předplatného webhooku ve vašem účtu.
Úroveň webhooku	webhookLevel	True	string	Účet: aktivuje se pro všechny obálky (web a rozhraní API). Aplikace API: Aktivuje se pouze pro obálky vytvořené prostřednictvím rozhraní API.
Tajný kód Webhooku	webhookSecret		string	Optional. Foxit eSign podepíše každou datovou část webhooku pomocí HMAC-SHA-256 pomocí tohoto tajného kódu pro ověření.

Návraty

Data události přijatá z eSign Foxit při spuštění události webhooku.

WebhookEventPayload: WebhookEventPayload

Definice

WebhookEventPayload

Data události přijatá z eSign Foxit při spuštění události webhooku.

Name	Cesta	Typ	Description
Název události	event_name	string	Název události, která se aktivovala (např. folder_sent, folder_signed, folder_executed).
Datum události	event_date	integer	Datum a čas, kdy došlo k události (unixové časové razítko v milisekundách).
ID	data.folder.folderId	integer	Jedinečné ID obálky.
Name	data.folder.folderName	string	Název obálky.
Vlastní název	data.folder.folderCustomName	string	Vlastní název přiřazený k obálce.
Heslo	data.folder.folderPassword	string	Heslo pro přístup k obálce, pokud je nastavené.
ID tvůrce	data.folder.folderAuthorId	integer	ID uživatele tvůrce obálky.
Jméno autora	data.folder.folderAuthorFirstName	string	Jméno autora obálky.
Příjmení autora	data.folder.folderAuthorLastName	string	Příjmení tvůrce obálky.
E-mail pro tvůrce	data.folder.folderAuthorEmail	string	E-mailová adresa tvůrce obálky.
Role tvůrce	data.folder.folderAuthorRole	string	Role účtu tvůrce obálky.
ID společnosti	data.folder.folderCompanyId	integer	ID společnosti, které vlastní obálku.
Datum vytvoření	data.folder.folderCreationDate	integer	Datum vytvoření obálky (unixové časové razítko v milisekundách).
Datum odeslání	data.folder.folderSentDate	integer	Datum odeslání obálky (unixové časové razítko v milisekundách).
Stav	data.folder.folderStatus	string	Aktuální stav obálky.
Vlastní pole 1	data.folder.custom_field1	string	První vlastní pole metadat.
Vlastní pole 2	data.folder.custom_field2	string	Druhé vlastní pole metadat.
Metadata	data.folder.metadata	string	Vlastní metadata přidružená k obálce
ID dokumentů	data.folder.folderDocumentIds	array of integer	Seznam ID dokumentů v obálce
Documents	data.folder.documentsList	array of object	Seznam dokumentů v obálce.
ID dokumentu	data.folder.documentsList.documentId	integer	Jedinečný identifikátor dokumentu.
ID smlouvy	data.folder.documentsList.contractId	integer	ID smlouvy pro tento dokument.
ID společnosti	data.folder.documentsList.companyId	integer	ID společnosti pro tento dokument.
Vytvořeno kým	data.folder.documentsList.contractCreatedBy	integer	ID uživatele osoby, která smlouvu vytvořila.
Vytvořeno dne	data.folder.documentsList.contractCreatedOn	integer	Datum vytvoření kontraktu (časové razítko unixu v milisekundách).
Typ smlouvy	data.folder.documentsList.contractType	string	Typ smlouvy.
Stav smlouvy	data.folder.documentsList.contractStatus	string	Aktuální stav smlouvy.
Upravitelný	data.folder.documentsList.editable	boolean	Určuje, jestli je dokument upravitelný.
ID verze	data.folder.documentsList.contractVersionId	integer	ID verze kontraktu.
Název verze	data.folder.documentsList.contractVersionName	string	Název verze smlouvy.
Popis verze	data.folder.documentsList.contractVersionDesc	string	Popis verze smlouvy.
Verze vytvořená uživatelem	data.folder.documentsList.versionCreatedby	integer	ID uživatele osoby, která tuto verzi vytvořila.
Verze vytvořená dne	data.folder.documentsList.versionCreatedOn	integer	Datum vytvoření této verze (časové razítko unixu v milisekundách).
Číslo verze	data.folder.documentsList.contractVersionNumber	integer	Číslo verze smlouvy.
Zdroj transakcí	data.folder.documentsList.contractTransactionSource	string	Zdrojový systém, který inicioval kontrakt.
Příjemci	data.folder.folderRecipientParties	array of object	Seznam příjemců pro tuto obálku
ID příjemce	data.folder.folderRecipientParties.partyId	integer	Jedinečný identifikátor příjemce.
ID příjemce	data.folder.folderRecipientParties.partyDetails.partyId	integer	Jedinečné ID příjemce.
Křestní jméno	data.folder.folderRecipientParties.partyDetails.firstName	string	Jméno příjemce.
Příjmení	data.folder.folderRecipientParties.partyDetails.lastName	string	Příjmení příjemce.
Email	data.folder.folderRecipientParties.partyDetails.emailId	string	E-mailová adresa příjemce.
Zástupný text	data.folder.folderRecipientParties.partyDetails.placeholder	boolean	Určuje, jestli se jedná o zástupného příjemce.
Address	data.folder.folderRecipientParties.partyDetails.address	string	Adresa příjemce.
Datum vytvoření	data.folder.folderRecipientParties.partyDetails.dateCreated	integer	Datum vytvoření záznamu příjemce (unixové časové razítko v milisekundách).
Odhlášení e-mailů	data.folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Jestli se příjemce odhlásil z e-mailů.
Jedinečné ID	data.folder.folderRecipientParties.partyDetails.uniquePartyId	string	Jedinečný systémový identifikátor tohoto příjemce.
Úroveň ověřování	data.folder.folderRecipientParties.partyDetails.authenticationLevel	string	Metoda ověřování pro tohoto příjemce.
Datum aktualizace hesla	data.folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	Datum poslední aktualizace hesla.
Stav hesla	data.folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Zda bylo heslo aktualizováno.
Vytáčení kódu	data.folder.folderRecipientParties.dialingCode	string	Kód mezinárodního vytáčení.
Mobile	data.folder.folderRecipientParties.mobileNumber	string	Číslo mobilního zařízení příjemce.
Typ podpisu	data.folder.folderRecipientParties.signerSignatureType	string	Typ podpisu, který podepisující znak použije.
Permissions	data.folder.folderRecipientParties.contractPermissions	string	Oprávnění udělená tomuto příjemci.
Podpisová objednávka	data.folder.folderRecipientParties.partySequence	integer	Podpisová objednávka pro tohoto příjemce.
Pořadí pracovních postupů	data.folder.folderRecipientParties.workflowSignSequence	integer	Pořadové číslo podepisujícího pracovního postupu
ID obálky	data.folder.folderRecipientParties.envelopeId	integer	ID obálky přidružené k tomuto příjemci.
ID společnosti příjemce	data.folder.folderRecipientParties.partyCompanyId	integer	ID společnosti tohoto příjemce.
Režim sdílení	data.folder.folderRecipientParties.sharingMode	string	Režim sdílení pro tohoto příjemce
Podpisová adresa URL příjemce	data.folder.folderRecipientParties.folderAccessURL	string	Adresa URL tohoto příjemce pro přístup a podepsání obálky.
Režim zabezpečení	data.folder.folderRecipientParties.securityMode	string	Režim zabezpečení pro tohoto příjemce.
Komentáře	data.folder.folderRecipientParties.extraComments	string	Další komentáře pro příjemce
Povolit změnu názvu	data.folder.folderRecipientParties.allowNameChange	boolean	Určuje, jestli příjemce může aktualizovat své jméno.
Název aktualizován	data.folder.folderRecipientParties.signerNameUpdated	boolean	Jestli podepisující správce aktualizoval jméno.
Úroveň ověřování podepisující osoby	data.folder.folderRecipientParties.signerAuthenticationLevel	string	Úroveň ověřování vyžadovaná pro podepisující osoby.
Přístupový kód	data.folder.folderRecipientParties.userDefinedAccessCode	string	Vlastní přístupový kód podepisující osoby.
ID podpisu	data.folder.folderRecipientParties.signatureId	string	ID použitého podpisu.
Úloha	data.folder.folderRecipientParties.partyRole	string	Role tohoto příjemce v pracovním postupu podepisování.
Pole společnosti	data.folder.folderRecipientParties.companyFieldValue	string	Hodnota pole název společnosti.
Pole nadpisu	data.folder.folderRecipientParties.titleFieldValue	string	Hodnota pole nadpisu.
Důvod podepisování	data.folder.folderRecipientParties.reasonSigning	string	Důvod podpisu.
Přidáno platební pole	data.folder.folderRecipientParties.payFieldAdded	boolean	Zda bylo přidáno pole platby.
Příjemce	data.folder.folderRecipientParties.payee	boolean	Zda je příjemce příjemcem.
Opakovaná platba	data.folder.folderRecipientParties.recurringFieldExist	boolean	Zda existuje opakující se platební pole.
Tisk a podepsání hotovo	data.folder.folderRecipientParties.printAndSignCompleted	boolean	Jestli je tisk a znaménko dokončené.
Volitelné podepisující osoby	data.folder.folderRecipientParties.allowOptionalSigner	boolean	Určuje, jestli je tento příjemce volitelným podepisovačem.
Volitelné podepisující osoby	data.folder.folderRecipientParties.optionalSigners	array of integer	Volitelná ID stran podepisující osoby.
Paid	data.folder.folderRecipientParties.paid	boolean	Zda byla platba dokončena.
Adresa URL pro autory přístupu	data.folder.folderAccessURLForAuthor	string	Adresa URL pro autora obálky pro přístup k obálce.
Adresa URL přístupu konceptu	data.folder.draftFolderAccessURL	string	Adresa URL pro přístup k obálce ve stavu konceptu.
Podepisování na panelu	data.folder.boardRoomSign	boolean	Určuje, jestli je povolený režim podepisování z panelu.
Zahrnout logo	data.folder.includeLogo	boolean	Určuje, jestli je logo společnosti součástí e-mailů.
Barva pozadí tlačítka	data.folder.email_btnBgColor	string	Barva pozadí tlačítka akce e-mailu
Barva textu tlačítka	data.folder.email_btnTxtColor	string	Barva textu tlačítka akce e-mailu
Logo e-mailu	data.folder.emailTemplateLogo	string	Adresa URL loga použitá v e-mailové šabloně.
ID šablony e-mailu	data.folder.emailTemplateId	integer	ID použité šablony e-mailu.
Záhlaví e-mailu	data.folder.emailHeader	string	Text záhlaví v e-mailech s oznámeními
Zápatí e-mailu	data.folder.emailFooter	string	Text zápatí v e-mailech s oznámeními
Vyprázdnění naplánované	data.folder.purgeFlag	boolean	Zda je obálka naplánována pro vyprázdnění.
Vyprázdnit počáteční datum	data.folder.purgeStartDate	string	Počáteční datum plánu vyprázdnění
Vyprázdnit koncové datum	data.folder.purgeEndDate	string	Koncové datum plánu vyprázdnění.
Hromadné ID	data.folder.bulkId	integer	ID operace hromadného odeslání( pokud je k dispozici).
Vynucení pořadí podpisu	data.folder.enforceSignWorkflow	boolean	Určuje, jestli se příjemci musí přihlásit k definovanému pořadí.
Aktuální krok pracovního postupu	data.folder.currentWorkflowStep	integer	Aktuální krok v pracovním postupu podepisování.
Zdroj transakcí	data.folder.transactionSource	string	Zdrojový systém, který inicioval tuto transakci.
Upravitelný	data.folder.editable	boolean	Zda je obálka upravitelná.
podepisování In-Person	data.folder.inPersonSignable	boolean	Určuje, jestli obálka podporuje podepisování osobně.
Přepsání připomenutí	data.folder.overrideAccountReminders	boolean	Určuje, jestli se přepíše nastavení připomenutí na úrovni účtu.
Přepsat delegování	data.folder.overrideAccountRecipientDelegation	boolean	Určuje, jestli se přepíše nastavení delegování na úrovni účtu.
Povolit delegování	data.folder.allowRecipientsToDelegate	boolean	Určuje, jestli můžou příjemci delegovat podepisování.
ID	data.folder.envelopeId	integer	Jedinečné ID obálky (alias folderId).
Name	data.folder.envelopeName	string	Název obálky (alias folderName).
ID původce	data.folder.envelopeOriginatorId	integer	ID uživatele, který pochází z obálky.
ID společnosti	data.folder.envelopeCompanyId	integer	ID společnosti, které vlastní obálku.
Date	data.folder.envelopeDate	integer	Datum vytvoření obálky (unixové časové razítko v milisekundách).
Sdílené datum	data.folder.envelopeSharedDate	integer	Datum, kdy byla obálka sdílena (unixové časové razítko v milisekundách).
Stav	data.folder.envelopeStatus	string	Aktuální stav obálky.
ID kontraktů	data.folder.envelopeContractIds	array of integer	ID kontraktu přidružené k této obálce.
Oprávnění stran	data.folder.envelopePartyPermissions	array of object	Seznam oprávnění příjemce (stejná struktura jako Příjemci)
ID příjemce	data.folder.envelopePartyPermissions.partyId	integer	Jedinečný identifikátor příjemce.
ID příjemce	data.folder.envelopePartyPermissions.partyDetails.partyId	integer
Křestní jméno	data.folder.envelopePartyPermissions.partyDetails.firstName	string
Příjmení	data.folder.envelopePartyPermissions.partyDetails.lastName	string
Email	data.folder.envelopePartyPermissions.partyDetails.emailId	string
Zástupný text	data.folder.envelopePartyPermissions.partyDetails.placeholder	boolean
Address	data.folder.envelopePartyPermissions.partyDetails.address	string
Datum vytvoření	data.folder.envelopePartyPermissions.partyDetails.dateCreated	integer
Odhlášení e-mailů	data.folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean
Jedinečné ID	data.folder.envelopePartyPermissions.partyDetails.uniquePartyId	string
Úroveň ověřování	data.folder.envelopePartyPermissions.partyDetails.authenticationLevel	string
Datum aktualizace hesla	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string
Stav hesla	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean
Vytáčení kódu	data.folder.envelopePartyPermissions.dialingCode	string
Mobile	data.folder.envelopePartyPermissions.mobileNumber	string
Typ podpisu	data.folder.envelopePartyPermissions.signerSignatureType	string
Permissions	data.folder.envelopePartyPermissions.contractPermissions	string
Podpisová objednávka	data.folder.envelopePartyPermissions.partySequence	integer
Pořadí pracovních postupů	data.folder.envelopePartyPermissions.workflowSignSequence	integer
ID obálky	data.folder.envelopePartyPermissions.envelopeId	integer
ID společnosti příjemce	data.folder.envelopePartyPermissions.partyCompanyId	integer
Režim sdílení	data.folder.envelopePartyPermissions.sharingMode	string
Podpisová adresa URL příjemce	data.folder.envelopePartyPermissions.folderAccessURL	string
Režim zabezpečení	data.folder.envelopePartyPermissions.securityMode	string
Komentáře	data.folder.envelopePartyPermissions.extraComments	string
Povolit změnu názvu	data.folder.envelopePartyPermissions.allowNameChange	boolean
Název aktualizován	data.folder.envelopePartyPermissions.signerNameUpdated	boolean
Úroveň ověřování podepisující osoby	data.folder.envelopePartyPermissions.signerAuthenticationLevel	string
Přístupový kód	data.folder.envelopePartyPermissions.userDefinedAccessCode	string
ID podpisu	data.folder.envelopePartyPermissions.signatureId	string
Úloha	data.folder.envelopePartyPermissions.partyRole	string
Pole společnosti	data.folder.envelopePartyPermissions.companyFieldValue	string
Pole nadpisu	data.folder.envelopePartyPermissions.titleFieldValue	string
Důvod podepisování	data.folder.envelopePartyPermissions.reasonSigning	string
Přidáno platební pole	data.folder.envelopePartyPermissions.payFieldAdded	boolean
Příjemce	data.folder.envelopePartyPermissions.payee	boolean
Opakovaná platba	data.folder.envelopePartyPermissions.recurringFieldExist	boolean
Tisk a podepsání hotovo	data.folder.envelopePartyPermissions.printAndSignCompleted	boolean
Volitelné podepisující osoby	data.folder.envelopePartyPermissions.allowOptionalSigner	boolean
Volitelné podepisující osoby	data.folder.envelopePartyPermissions.optionalSigners	array of integer
Paid	data.folder.envelopePartyPermissions.paid	boolean
Úroveň ověřování	data.folder.envelopeAuthenticationLevel	string	Úroveň ověřování vyžadovaná pro obálku.
Hromadné jednotné přihlašování	data.folder.allowSingleSignerInBulk	boolean	Určuje, jestli je jednotné přihlašování povolené v hromadném režimu.
název složky File-Based	data.folder.folderNameBasedOnFileNaming	boolean
název dokumentu File-Based	data.folder.documentNameBasedOnFileNaming	boolean
Název certifikátu File-Based	data.folder.certificateNameBasedOnFileNaming	boolean
Pojmenování souborů pre-Exec	data.folder.enableFileNamingBeforeExecution	boolean
Příjemce přidán	data.folder.payeeAddedd	boolean
Self-Signing povoleno	data.folder.selfSignerEnabled	boolean
Notář povoleno	data.folder.notaryEnabled	boolean
Omezená viditelnost	data.folder.limitedVisibilityFlag	boolean
Viditelnost po podepsání	data.folder.postSigningVisibility	boolean
Mokrý podpis	data.folder.wetSignatureEnabled	boolean
Sloučit povoleno	data.folder.mergeEnabled	boolean

binární

Toto je základní datový typ Binary.