Referenční příručka polí¶
Modul Signi rozšiřuje standardní entitu Document o následující pole a vztahy.
Entita: Document¶
Tato pole jsou přidána k entitě Dokument pro řízení procesu podepisování.
| Název pole (System Name) | Typ | Popis | Vlastnosti |
|---|---|---|---|
signiId |
Varchar (40) | Unikátní identifikátor kontraktu v systému Signi. | Client ReadOnly |
isSend |
Boolean | Indikuje, zda byl dokument úspěšně odeslán do Signi. | NotNull, Client ReadOnly |
isSigned |
Boolean | Indikuje, zda je proces podepisování dokončen (všichni podepsali). | NotNull, Client ReadOnly |
sendDate |
Date | Datum, kdy byl dokument odeslán k podpisu. | - |
signatureDate |
DateTime | Datum a čas, kdy byl proces podpisu dokončen. | - |
signatureLocation |
Enum | Způsob podepisování. Možnosti: Remote Signature, In-person Signature. |
Required, Default: Remote |
signiDocumentLink |
Url | Přímý odkaz na dokument v rozhraní Signi. | Client ReadOnly |
signedDocument |
File | Odkaz na finální podepsaný soubor (PDF). | - |
internalSigners |
LinkMultiple | Vazba na uživatele (User), kteří dokument podepisují (Navrhovatelé). |
- |
externalSigners |
LinkMultiple | Vazba na kontakty (Contact), kteří dokument podepisují (Protistrana). |
- |
Vazby (Relationships)¶
| Název vazby | Cílová entita | Typ | Popis |
|---|---|---|---|
internalSigners |
User |
Many-to-Many | Uživatelé vystupující jako navrhovatelé/podepisující za firmu. |
externalSigners |
Contact |
Many-to-Many | Externí osoby (zákazníci), které mají dokument podepsat. |
Výčty (Enums)¶
signatureLocation¶
Definuje, jakým způsobem bude podpis realizován.
- Remote Signature: Standardní proces na dálku. Podepisující obdrží e-mail s odkazem, pro ověření může být vyžadována SMS (dle nastavení Signi účtu).
- In-person Signature: Podpis "na místě". Předpokládá se, že navrhovatel a podepisující jsou u jednoho zařízení (např. tablet). V požadavku na API se nastavuje parametr
one_device: true.