GetAccept
A GetAccept értékesítési platformot biztosít az értékesítési dokumentumok tervezéséhez, elküldéséhez, előléptetéséhez, nyomon követéséhez és e-aláírásához, valamint az értékesítési biztosítékok, a szerződéskezelés, a javaslatok és az elektronikus aláírások egy helyen történő használatához.
Ez az összekötő a következő termékekben és régiókban érhető el:
| Service | Class | Régiók |
|---|---|---|
| Copilot Studio | prémium | Az összes Power Automate-régió, kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD) |
| Logikai alkalmazások | Standard | Az összes Logic Apps-régió , kivéve a következőket: - Azure Government-régiók - Azure China-régiók - Amerikai Védelmi Minisztérium (DoD) |
| Power Alkalmazások | prémium | Az összes Power Apps-régió , kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD) |
| Power Automate | prémium | Az összes Power Automate-régió, kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD) |
| Érintkezés | |
|---|---|
| Név | GetAccept API-csapat |
| URL | https://app.getaccept.com/api |
| integrations@getaccept.com |
| Összekötő metaadatai | |
|---|---|
| Kiadó | GetAccept, Inc. |
| Webhely | https://www.getaccept.com |
| Adatvédelmi irányelvek | https://www.getaccept.com/privacy-policy |
| Kategóriák | Értékesítés és CRM; Termelékenység |
A GetAccept értékesítési platformot biztosít az értékesítési dokumentumok tervezéséhez, elküldéséhez, előléptetéséhez, nyomon követéséhez és e-aláírásához, valamint az értékesítési biztosítékok, a szerződéskezelés, a javaslatok és az elektronikus aláírások egy helyen történő használatához. Ez az összekötő segít automatizálni a munkafolyamatokat a dokumentumtároláshoz, a lekéréshez, a feladat-hozzárendeléshez és a testreszabott értesítésekhez.
Előfeltételek
A kapcsolat használatához GetAccept-fiók szükséges. Nyissa meg a getaccept.com az ingyenes fiók regisztrálásához.
Hogyan szerezhet be hitelesítő adatokat?
Csak érvényes GetAccept-fiókra van szükség, mivel az OAuth2 használatával hitelesíti az aktuális bejelentkezett felhasználót a GetAcceptben.
Ismert problémák és korlátozások
Az integrációval kapcsolatos problémákért forduljon a [mailto:support@getaccept.com](technikai támogatási szolgálathoz).
Szabályozási korlátok
| Name | Hívások | Megújítási időszak |
|---|---|---|
| API-hívások kapcsolatonként | 100 | 60 másodperc |
Műveletek
| Dokumentum címzettjeinek lekérése |
Egy adott dokumentum címzettjeinek listájának lekérése. |
| Dokumentum lejáratának frissítése |
Ezzel a módszerrel frissítheti a dokumentum lejárati dátumát és idejét. |
| Dokumentum letöltése |
A dokumentumfájl mindig letölthető, de nagy valószínűséggel le szeretné tölteni, ha aláírt állapotú. Kiválaszthat egy letöltési URL-címet, vagy lekérheti a bináris fájlt. A letöltési URL-cím a kérést követően 10 perccel érhető el. |
| Dokumentum részleteinek lekérése |
Dokumentumadatok lekérése egy dokumentumazonosító megadásával. |
| Dokumentum vagy sablon létrehozása és elküldése |
Létre kell hoznia egy dokumentumot, hogy elküldhesse azt egy címzettnek. Dokumentum létrehozásakor hivatkozhat a korábban feltöltött fájlokra file_id, vagy létrehozhat egy dokumentumot, és feltöltheti a fájlokat AZ API-bejegyzésbe. Egy fájlt csak akkor tölthet fel, ha a POST dokumentum létrehozásakor bele van adva egy fájl. Használja file_ids paramétert a meglévő feltöltött fájl(ok) használatára, file_content a dokumentum base64 kódolású sztringként való elküldéséhez, vagy többrészes bejegyzést hajthat végre fájlparaméterrel. Minden címzettnek érvényes e-mail vagy mobilszámmal kell rendelkeznie. Minden eseményt a rendszer a kérelmező IP-címének használatával rögzít. Ezt felülbírálhatja a végfelhasználók nyilvános IP-címét tartalmazó fejléc CLIENT_IP használatával. |
| Dokumentumfájl feltöltése |
Egyszerre egy fájlt tölthet fel, és lekérheti a fájlazonosítót. A fájlazonosító a címzetteknek küldött GetAccept-dokumentumhoz való csatlakozásra szolgál. Ha több POST fájlt szeretne feltölteni, akkor több POST-fájlt is futtat. Alapértelmezés szerint csak legfeljebb 10 MB méretű fájlokat fogadunk el. A feltöltött fájlt a feltöltést követő 48 órán belül importálni/hozzáadni kell egy dokumentumhoz. Azt javasoljuk, hogy töltsön fel PDF-fájlokat annak érdekében, hogy a küldéskor is ugyanolyan megjelenést biztosíthasson. Más fájltípusok is konvertálhatók, például: Mirosoft Office: doc, docx, xl, xls, xlsx, ppt, pptx Mac: numbers, key Images: jpg, jpeg, png Egyéb: html, tex, csv |
| Dokumentummellékletek lekérése |
Dokumentummellékletek lekérése dokumentumazonosító megadásával. |
| Dokumentummezők lekérése |
Dokumentum vagy sablon mezőinek listájának lekérése. Dokumentum aláírása előtt és után is használható. |
| Dokumentumok listázása |
Az elérhető dokumentumok listájának lekérése |
| Felhasználó létrehozása |
Ezzel létrehoz egy új névjegyet az adatbázisban az aktuális entitáshoz |
| Felhasználói adatok lekérése |
Ez a hívás egyetlen felhasználó adatait adja vissza. Az aktuális hitelesített felhasználó adatainak és elérhető entitásainak fogadása a felhasználóazonosítóm használatával |
| Felhasználók listázása |
Az aktuális hitelesített entitás aktív felhasználóinak listájának lekérése |
| Kapcsolattartó létrehozása |
Ezzel létrehoz egy új névjegyet az adatbázisban az aktuális entitáshoz |
| Listasablonok |
Az elérhető dokumentumsablonok listájának fogadása. Új sablonokat a GetAccept Sablonok szakaszában vehet fel. |
| Meglévő dokumentum küldése |
Amikor a GetAccepten keresztül küld dokumentumot, minden címzettnek elküldünk egy e-mailt, amely egy egyedi, biztonságos hivatkozást tartalmaz. Ez az API-hívás aktiválja a dokumentumküldési műveletet, és csak document_status = piszkozatú dokumentumokon hajtható végre. A dokumentumot a rendszer elküldi a létrehozáskor megadott címzetteknek. Ha a dokumentum önaláírással lett létrehozva, azt a hitelesített vagy a megadott felhasználó is önaláírta a küldés előtt. |
| Melléklet feltöltése |
Feltöltheti a mellékletfájlokat, hogy belefoglalja az elküldött dokumentumokat. A sikeres kérés visszaadja a attachment_id. A attachment_id használatával csatolhat mellékletet egy dokumentumhoz. |
| Mellékletek listázása |
Az elérhető mellékletek listájának fogadása. Új mellékleteket új dokumentum használatával vehet fel a GetAcceptben. |
| Partnerek listázása |
Az aktuális entitáshoz elérhető névjegyek listájának fogadása. A címzettként hozzáadott összes névjegy névjegyként lesz mentve, és később is elérhető az adott entitáson. |
| Sablon díjszabási tábláinak lekérése |
Egy adott sablonhoz tartozó tarifatáblázatelemek listájának fogadása. |
| Sablonmezők lekérése |
Egy adott sablon mezőlistájának fogadása. |
| Sablonszerepkörök lekérése |
Egy adott sablon szerepköreinek listájának fogadása. |
| Videó feltöltése |
Feltöltheti a mellékletfájlokat, hogy belefoglalja az elküldött dokumentumokat. A sikeres kérés visszaadja a attachment_id. A attachment_id használatával csatolhat mellékletet egy dokumentumhoz. |
| Videók listázása |
Az entitáson elérhető videók listájának fogadása. Felvehet új videókat a mobilalkalmazásba vagy a GetAcceptbe. |
Dokumentum címzettjeinek lekérése
Egy adott dokumentum címzettjeinek listájának lekérése.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
Dokumentumazonosító |
Válaszok
Címzettek listája
- Címzettek
- Recipients
Dokumentum lejáratának frissítése
Ezzel a módszerrel frissítheti a dokumentum lejárati dátumát és idejét.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
Dokumentumazonosító |
|
Lejárati dátum
|
expiration_date | date-time |
A dokumentum lejáratának dátuma és időpontja (UTC) |
|
|
Értesítés küldése
|
send_notification | boolean |
Értesítést kell küldeni a frissítésről a címzetteknek |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Státusz
|
status | integer |
A frissítés állapota |
Dokumentum letöltése
A dokumentumfájl mindig letölthető, de nagy valószínűséggel le szeretné tölteni, ha aláírt állapotú.
Kiválaszthat egy letöltési URL-címet, vagy lekérheti a bináris fájlt.
A letöltési URL-cím a kérést követően 10 perccel érhető el.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
Dokumentumazonosító |
|
A bináris fájl közvetlen visszaadása
|
direct | string |
A bináris fájl közvetlen visszaadása |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
document_url
|
document_url | string | |
|
fájl
|
file | string |
Dokumentum részleteinek lekérése
Dokumentumadatok lekérése egy dokumentumazonosító megadásával.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
Dokumentumazonosító |
Válaszok
A dokumentum egy vagy több feltöltött fájl(ok), amelyet egy felhasználó által létrehozott egy vagy több címzettnek kell elküldeni.
- Dokumentum
- Document
Dokumentum vagy sablon létrehozása és elküldése
Létre kell hoznia egy dokumentumot, hogy elküldhesse azt egy címzettnek. Dokumentum létrehozásakor hivatkozhat a korábban feltöltött fájlokra file_id, vagy létrehozhat egy dokumentumot, és feltöltheti a fájlokat AZ API-bejegyzésbe. Egy fájlt csak akkor tölthet fel, ha a POST dokumentum létrehozásakor bele van adva egy fájl.
Használja file_ids paramétert a meglévő feltöltött fájl(ok) használatára, file_content a dokumentum base64 kódolású sztringként való elküldéséhez, vagy többrészes bejegyzést hajthat végre fájlparaméterrel.
Minden címzettnek érvényes e-mail vagy mobilszámmal kell rendelkeznie.
Minden eseményt a rendszer a kérelmező IP-címének használatával rögzít. Ezt felülbírálhatja a végfelhasználók nyilvános IP-címét tartalmazó fejléc CLIENT_IP használatával.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
azonosító
|
id | string |
A listáról vagy a feltöltés után kapott mellékletazonosító |
|
|
Nézet megkövetelése
|
require_view | boolean |
Annak megkövetelése, hogy a címzett megtekintse a mellékletet |
|
|
Típus
|
type | string |
fájl vagy külső fájl, ahol a fájl feltöltött fájl, a külső pedig egy külső fájlra mutató hivatkozás |
|
|
Mezőazonosító
|
id | string |
Egyéni sablonmező azonosítója |
|
|
Mező neve
|
name | string |
Egyéni sablonmező neve |
|
|
Mező értéke
|
value | string |
Egyéni sablonmező értéke |
|
|
Valuta
|
currency | string |
Pénznem, pl. SEK |
|
|
Helyszín
|
locale | string |
Területi beállítás, például sv-SE |
|
|
Megjelenítendő név
|
display_name | string |
A díjszabási tábla megjelenítendő neve |
|
|
Külső ID
|
external_id | string |
Külső azonosító az összefoglaló objektum külső rendszeren belüli ábrázolásához |
|
|
Táblaazonosító
|
id | string |
Táblaazonosító |
|
|
Előre kiszámított összegek
|
pre_calculated | boolean |
Ha a tarifatábla összegeit előre ki kell számítani |
|
|
Megjelenítendő név
|
display_name | string |
A díjszabási tábla megjelenítendő neve |
|
|
azonosító
|
id | string |
Szakaszazonosító |
|
|
Rows
|
rows |
Értékobjektumot tartalmazó tömb column_id, érték tömbjével |
||
|
Enabled
|
enabled | boolean |
Ha engedélyezni kell a szakaszkedvezményt |
|
|
Átalánydíj
|
flat_fee | boolean |
Ha a szakaszt átalánydíj-kedvezményekkel kell használni |
|
|
Kedvezmény értéke
|
value | string |
A szakaszkedvezmény értéke |
|
|
Enabled
|
enabled | boolean |
Ha a szakaszárat engedélyezni kell |
|
|
Átalánydíj
|
flat_fee | boolean |
Ha a szakaszt átalánydíjas díjszabással kell használni |
|
|
Árérték
|
value | string |
A szakasz árának értéke |
|
|
Enabled
|
enabled | boolean |
Ha engedélyezni kell a szakaszadót |
|
|
Átalánydíj
|
flat_fee | boolean |
Ha a szakaszt átalánydíj-adóval kell használni |
|
|
Adóérték
|
value | string |
A szakaszadó értéke |
|
|
Enabled
|
enabled | boolean |
Ha engedélyezni kell a díjszabási tábla kedvezményét |
|
|
Átalánydíj
|
flat_fee | boolean |
Ha a tarifatáblának átalánydíj-kedvezményeket kell használnia |
|
|
Kedvezmény értéke
|
value | string |
Az összegző kedvezmény értéke |
|
|
Enabled
|
enabled | boolean |
Ha engedélyezni kell a díjszabási tábla árát |
|
|
Átalánydíj
|
flat_fee | boolean |
Ha a tarifatáblának átalánydíjas díjszabást kell használnia |
|
|
Árérték
|
value | string |
Az összegző ár értéke |
|
|
Enabled
|
enabled | boolean |
Ha engedélyezni kell a díjszabási táblaadót |
|
|
Átalánydíj
|
flat_fee | boolean |
Ha a tarifatáblának átalánydíjadót kell használnia |
|
|
Érték
|
value | string |
Az összegző adó értéke |
|
|
Lejárati dátum
|
expiration_date | date-time |
A dokumentum lejáratának dátuma és időpontja |
|
|
Külső ID
|
external_id | string |
Külső rendszerazonosító azonosításhoz |
|
|
Fájltartalom
|
file_content | string |
Base64 kódolású fájltartalom |
|
|
Fájlazonosítók
|
file_ids | string |
Vesszővel tagolt, egyedi fájlazonosítók érkeznek a fájlok feltöltésekor |
|
|
Fájlnév
|
file_name | string |
A dokumentum fájlneve a kiterjesztéssel. Ez hasznos lehet a különböző fájltípusok konvertálásához. |
|
|
Fájl URL-címe
|
file_url | string |
A dokumentumfájl URL-címe. A dokumentumoknak nyilvánosan letölthetőnek kell lenniük |
|
|
Automatikus küldés
|
is_automatic_sending | boolean |
Ha a dokumentumot a létrehozás után kell elküldeni |
|
|
Emlékeztetők küldése
|
is_reminder_sending | boolean |
Automatikus emlékeztetők küldése |
|
|
Küldés ütemezése
|
is_scheduled_sending | boolean |
Ha a küldés a jövőbeni küldésre van ütemezve |
|
|
Dokumentum aláírása
|
is_signing | boolean |
Ha a dokumentumot aláírásra küldik |
|
|
Kézzel írt aláírás
|
is_signing_biometric | boolean |
Kézzel írt aláírás használata |
|
|
Aláírásátvitel engedélyezése
|
is_signing_forward | boolean |
Ha a címzettek át tudják adni az aláírási jogosultságokat |
|
|
Aláírás monogrammal
|
is_signing_initials | boolean |
Dokumentum aláírása címzett monogram használatával |
|
|
SMS küldése
|
is_sms_sending | boolean |
Ha a dokumentumot sms-ben küldi el a címzett mobilalkalmazásnak |
|
|
Dokumentum neve
|
name | True | string |
Adja meg a dokumentum nevét |
|
Cég neve
|
company_name | string |
A címzett cégneve |
|
|
Cégszám
|
company_number | string |
A címzett céges száma |
|
|
Email
|
string |
A címzett e-mail-címe |
||
|
Keresztnév
|
first_name | string |
Címzett utóneve |
|
|
Vezetéknév
|
last_name | string |
Címzett vezetékneve |
|
|
Mobil
|
mobile | string |
Mobiltelefon nemzetközi formátumban |
|
|
Megjegyzés:
|
note | string |
További megjegyzés címzettnek |
|
|
Aláírási rendelés
|
order_num | integer |
Ha az aláírási rendelés engedélyezve van |
|
|
Címzett típusa
|
role | string |
A címzett típusa a dokumentumban |
|
|
Sablonszerepkör
|
role_name | string |
A szerepkör neve egy sablonban |
|
|
EID ellenőrzése
|
verify_eid | boolean |
Ellenőrzés az EID használatával |
|
|
EID-típus
|
verify_eid_type | string |
Személyes ellenőrzéshez használandó EID-típus |
|
|
Kérdés engedélyezése
|
verify_qna | boolean |
Kérdés felteendő |
|
|
Ellenőrző válasz
|
verify_qna_answer | string |
A kérdésre adott válasz |
|
|
Nyitott kérdés
|
verify_qna_open | boolean |
Kérdéseket kell feltenni a dokumentum megnyitása előtt |
|
|
Ellenőrzési kérdés
|
verify_qna_question | string |
Ellenőrzés kérésére szolgáló kérdés |
|
|
Kérdés aláírása
|
verify_qna_sign | boolean |
Ha az aláírás előtt fel kell tenni egy kérdést |
|
|
SMS ellenőrzése
|
verify_sms | boolean |
Címzett ellenőrzése SMS-ben |
|
|
SMS ellenőrzése nyitva
|
verify_sms_open | boolean |
SMS ellenőrzése nyitva |
|
|
Ellenőrzés SMS-ben
|
verify_sms_sign | boolean |
Ha egy SMS-ben ellenőrizni kell a címzettet az aláírás előtt |
|
|
Küldési dátum ütemezése
|
scheduled_sending_time | date-time |
A dokumentum elküldésének dátuma és időpontja |
|
|
Feladó e-mail felülbírálása
|
sender_email | string |
Küldés más e-mailről, mint hitelesített felhasználó |
|
|
Feladó felhasználó felülbírálása
|
sender_id | string |
Küldés más felhasználótól, mint hitelesített felhasználótól |
|
|
Sablon ID
|
template_id | string |
Válassza ki a küldéshez használni kívánt sablont |
|
|
Dokumentum típusa
|
type | string |
A dokumentum típusának/kategóriájának beállítása |
|
|
Dokumentum értéke
|
value | integer |
Ügylet vagy dokumentum értéke |
|
|
Videoazonosító
|
video_id | string |
Válassza ki a küldéshez használni kívánt videót |
Válaszok
A dokumentum egy vagy több feltöltött fájl(ok), amelyet egy felhasználó által létrehozott egy vagy több címzettnek kell elküldeni.
- Dokumentum
- Document
Dokumentumfájl feltöltése
Egyszerre egy fájlt tölthet fel, és lekérheti a fájlazonosítót. A fájlazonosító a címzetteknek küldött GetAccept-dokumentumhoz való csatlakozásra szolgál. Ha több POST fájlt szeretne feltölteni, akkor több POST-fájlt is futtat. Alapértelmezés szerint csak legfeljebb 10 MB méretű fájlokat fogadunk el. A feltöltött fájlt a feltöltést követő 48 órán belül importálni/hozzáadni kell egy dokumentumhoz.
Azt javasoljuk, hogy töltsön fel PDF-fájlokat annak érdekében, hogy a küldéskor is ugyanolyan megjelenést biztosíthasson. Más fájltípusok is konvertálhatók, például:
Mirosoft Office: doc, docx, xl, xls, xlsx, ppt, pptx Mac: numbers, key Images: jpg, jpeg, png Egyéb: html, tex, csv
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fájltartalom
|
file_content | string |
Küldje el a fájlt base64 kódolásúként. Vegye figyelembe, hogy a base64 kódolási fájlok körülbelül 30% |
|
|
Fájlnév
|
file_name | string |
A dokumentum fájlneve a kiterjesztéssel. Ez hasznos lehet a különböző fájltípusok konvertálásához. |
|
|
Fájl URL-címe
|
file_url | string |
A dokumentumfájl URL-címe. A fájlnak minden engedély nélkül letölthetőnek kell lennie |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
fájl_azonosító
|
file_id | string |
A file_ids dokumentum létrehozásakor használandó feltöltött fájl azonosítója |
|
file_status
|
file_status | string |
A feltöltött fájl állapota |
Dokumentummellékletek lekérése
Dokumentummellékletek lekérése dokumentumazonosító megadásával.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
Dokumentumazonosító |
Válaszok
Mellékletlista
- Attachments
- Attachments
Dokumentummezők lekérése
Dokumentum vagy sablon mezőinek listájának lekérése. Dokumentum aláírása előtt és után is használható.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
Dokumentumazonosító |
Válaszok
Mezőlista
- Fields
- Fields
Dokumentumok listázása
Az elérhető dokumentumok listájának lekérése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Szűrési lista az állapoton
|
filter | string |
Szűrési lista az állapoton |
|
|
Eredmények rendezése
|
sort_by | string |
Eredmények rendezése |
|
|
Találatok sorrendje
|
sort_order | string |
Találatok sorrendje |
|
|
A csapattagok dokumentumainak belefoglalása
|
showteam | boolean |
A csapattagok dokumentumainak belefoglalása |
|
|
Az entitás összes dokumentumának belefoglalása
|
showall | boolean |
Az entitás összes dokumentumának belefoglalása |
|
|
Külső ID
|
external_id | string |
A külső azonosító egy egyéni mező, amely a GetAccepten kívüli rendszerből származó egyedi rekordazonosítót tartalmazhat |
|
|
Kiegyenlít
|
offset | number |
Lista indítása az x rekordtól a korlátig |
|
|
Limit
|
limit | number |
Listázandó rekordok száma |
Válaszok
Dokumentumlista
- Elemek
- Documents
Felhasználó létrehozása
Ezzel létrehoz egy új névjegyet az adatbázisban az aktuális entitáshoz
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
company_name
|
company_name | string |
Társított vállalatnév |
|
|
company_number
|
company_number | string |
Társított cégszám |
|
|
e-mail
|
string |
A kapcsolattartó e-mail-címe |
||
|
first_name
|
first_name | string |
A partner utóneve |
|
|
fullname
|
fullname | string |
Teljes név megadása utónév/vezetéknév helyett |
|
|
last_name
|
last_name | string |
A partner vezetékneve |
|
|
mobil
|
mobile | string |
Mobilszám nemzetközi formátumban |
|
|
jegyzet
|
note | string |
Nem kötelező belső megjegyzés a partnerhez |
|
|
phone
|
phone | string |
Telefonszám nemzetközi formátumban |
|
|
title
|
title | string |
A kapcsolattartó címe, pl. vezérigazgató, értékesítési vezető |
Válaszok
A felhasználót az e-mail-címe határozza meg, és egy vagy több entitáshoz kapcsolódik.
Felhasználói szerepkörök
Adminisztrátor:
- Az összes dokumentum megtekintése
- Az összes dokumentum szerkesztése
- Entitásbeállítások, adatok és számlázás módosítása
- Új felhasználók hozzáadása az entitáshoz
- Entitásszerepkörök hozzárendelése
Menedzser:
- Csoportdokumentumok megtekintése
- Az összes dokumentum szerkesztése
- Új felhasználók hozzáadása az entitáshoz
Entitás
Az entitás a legfelső csomópont, és az összes felhasználó és a kapcsolódó dokumentum egy entitáshoz csatlakozik. Az entitások gyakran megegyeznek egy nagy szervezet vállalatával, országával vagy részlegével.
- User
- User
Felhasználói adatok lekérése
Ez a hívás egyetlen felhasználó adatait adja vissza. Az aktuális hitelesített felhasználó adatainak és elérhető entitásainak fogadása a felhasználóazonosítóm használatával
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Felhasználói azonosító
|
userId | True | string |
Felhasználói azonosító |
Válaszok
A felhasználót az e-mail-címe határozza meg, és egy vagy több entitáshoz kapcsolódik.
Felhasználói szerepkörök
Adminisztrátor:
- Az összes dokumentum megtekintése
- Az összes dokumentum szerkesztése
- Entitásbeállítások, adatok és számlázás módosítása
- Új felhasználók hozzáadása az entitáshoz
- Entitásszerepkörök hozzárendelése
Menedzser:
- Csoportdokumentumok megtekintése
- Az összes dokumentum szerkesztése
- Új felhasználók hozzáadása az entitáshoz
Entitás
Az entitás a legfelső csomópont, és az összes felhasználó és a kapcsolódó dokumentum egy entitáshoz csatlakozik. Az entitások gyakran megegyeznek egy nagy szervezet vállalatával, országával vagy részlegével.
- User
- User
Felhasználók listázása
Az aktuális hitelesített entitás aktív felhasználóinak listájának lekérése
Válaszok
Felhasználói lista
- Felhasználók
- Users
Kapcsolattartó létrehozása
Ezzel létrehoz egy új névjegyet az adatbázisban az aktuális entitáshoz
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Cégnév
|
company_name | string |
Társított vállalatnév |
|
|
Cégszám
|
company_number | string |
Társított cégszám |
|
|
Email
|
string |
A kapcsolattartó e-mail-címe |
||
|
Keresztnév
|
first_name | string |
A partner utóneve |
|
|
Teljes név
|
fullname | string |
Teljes név megadása utónév/vezetéknév helyett |
|
|
Vezetéknév
|
last_name | string |
A partner vezetékneve |
|
|
Mobil
|
mobile | string |
Mobilszám nemzetközi formátumban |
|
|
Megjegyzés:
|
note | string |
Nem kötelező belső megjegyzés a partnerhez |
|
|
Telefonszám
|
phone | string |
Telefonszám nemzetközi formátumban |
|
|
Cím
|
title | string |
A kapcsolattartó címe, pl. vezérigazgató, értékesítési vezető |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Kapcsolattartó azonosítója
|
contact_id | string |
A létrehozott partner azonosítója |
Listasablonok
Az elérhető dokumentumsablonok listájának fogadása. Új sablonokat a GetAccept Sablonok szakaszában vehet fel.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Az összes megjelenítése
|
showall | string |
Az entitás összes sablonjának megjelenítése |
|
|
Mappaazonosító
|
folder_id | string |
Sablonok megjelenítése egy adott mappában |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
templates
|
templates | array of object | |
|
tags
|
templates.tags | string | |
|
létrehozás_időpontja
|
templates.created_at | string | |
|
external_editor_type
|
templates.external_editor_type | string | |
|
field_count
|
templates.field_count | integer | |
|
azonosító
|
templates.id | string | |
|
is_editable
|
templates.is_editable | boolean | |
|
is_private
|
templates.is_private | boolean | |
|
név
|
templates.name | string | |
|
page_count
|
templates.page_count | integer | |
|
role_count
|
templates.role_count | integer | |
|
sender_name
|
templates.sender_name | string | |
|
sender_thumb_url
|
templates.sender_thumb_url | string | |
|
thumb_url
|
templates.thumb_url | string | |
|
típus
|
templates.type | string | |
|
user_id
|
templates.user_id | string | |
|
video_id
|
templates.video_id | string | |
|
video_thumb_url
|
templates.video_thumb_url | string |
Meglévő dokumentum küldése
Amikor a GetAccepten keresztül küld dokumentumot, minden címzettnek elküldünk egy e-mailt, amely egy egyedi, biztonságos hivatkozást tartalmaz. Ez az API-hívás aktiválja a dokumentumküldési műveletet, és csak document_status = piszkozatú dokumentumokon hajtható végre. A dokumentumot a rendszer elküldi a létrehozáskor megadott címzetteknek.
Ha a dokumentum önaláírással lett létrehozva, azt a hitelesített vagy a megadott felhasználó is önaláírta a küldés előtt.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Dokumentumazonosító
|
documentId | True | string |
Dokumentumazonosító |
|
sender_email
|
sender_email |
Ezzel megadhatja a feladó felhasználóját/tulajdonosát a dokumentum önaláírásához használandó e-mail-cím alapján. |
||
|
sender_id
|
sender_id | string |
Ezzel megadhatja a feladó felhasználóját/tulajdonosát a dokumentum önaláírásához használandó azonosító alapján. |
Válaszok
A dokumentum egy vagy több feltöltött fájl(ok), amelyet egy felhasználó által létrehozott egy vagy több címzettnek kell elküldeni.
- Dokumentum
- Document
Melléklet feltöltése
Feltöltheti a mellékletfájlokat, hogy belefoglalja az elküldött dokumentumokat. A sikeres kérés visszaadja a attachment_id. A attachment_id használatával csatolhat mellékletet egy dokumentumhoz.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fájltartalom
|
file_content | string |
Küldje el a fájlt base64 kódolásúként. Vegye figyelembe, hogy a base64 kódolási fájlok körülbelül 30% |
|
|
Fájlnév
|
file_name | string |
A dokumentum fájlneve a kiterjesztéssel. Ez hasznos lehet a különböző fájltípusok konvertálásához. |
|
|
Fájl URL-címe
|
file_url | string |
A dokumentumfájl URL-címe. A fájlnak minden engedély nélkül letölthetőnek kell lennie |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Fájlnév
|
filename | string |
A melléklet fájlneve |
|
Melléklet azonosítója
|
id | string |
A attachment_id dokumentum létrehozásakor használandó feltöltött melléklet azonosítója |
|
Melléklet címe
|
title | string |
A melléklet címe |
|
Melléklet típusa
|
type | string |
A melléklet típusa |
Mellékletek listázása
Az elérhető mellékletek listájának fogadása. Új mellékleteket új dokumentum használatával vehet fel a GetAcceptben.
Válaszok
Mellékletlista
- Attachments
- Attachments
Partnerek listázása
Az aktuális entitáshoz elérhető névjegyek listájának fogadása. A címzettként hozzáadott összes névjegy névjegyként lesz mentve, és később is elérhető az adott entitáson.
Válaszok
Partnerlista
- Contacts
- Contacts
Sablon díjszabási tábláinak lekérése
Egy adott sablonhoz tartozó tarifatáblázatelemek listájának fogadása.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Sablon ID
|
templateId | True | string |
Sablon ID |
Válaszok
Tarifatáblák
- Pricing
- PricingTables
Sablonmezők lekérése
Egy adott sablon mezőlistájának fogadása.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Sablon ID
|
templateId | True | string |
Sablon ID |
Válaszok
Mezőlista
- Fields
- Fields
Sablonszerepkörök lekérése
Egy adott sablon szerepköreinek listájának fogadása.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Sablon ID
|
templateId | True | string |
Sablon ID |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
roles
|
roles | array of object | |
|
e-mail
|
roles.email | string | |
|
first_name
|
roles.first_name | string | |
|
last_name
|
roles.last_name | string | |
|
mobil
|
roles.mobile | string | |
|
szerepkör
|
roles.role | string | |
|
role_id
|
roles.role_id | string | |
|
role_name
|
roles.role_name | string |
Videó feltöltése
Feltöltheti a mellékletfájlokat, hogy belefoglalja az elküldött dokumentumokat. A sikeres kérés visszaadja a attachment_id. A attachment_id használatával csatolhat mellékletet egy dokumentumhoz.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fájltartalom
|
file_content | string |
Küldje el a fájlt base64 kódolásúként. Vegye figyelembe, hogy a base64 kódolási fájlok körülbelül 30% |
|
|
Fájlnév
|
file_name | string |
A dokumentum fájlneve a kiterjesztéssel. Ez hasznos lehet a különböző fájltípusok konvertálásához. |
|
|
Fájl URL-címe
|
file_url | string |
A dokumentumfájl URL-címe. A fájlnak minden engedély nélkül letölthetőnek kell lennie |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Fájl állapota
|
file_status | string |
A videó állapota |
|
Fájlnév
|
filename | string |
A videó fájlneve |
|
Feladat azonosítója
|
job_id | string |
A videó konvertálása és tömörítése feldolgozási feladat azonosítója. A feladat állapotfrissítéseinek lekérdezése a /video/feladat/<azonosító> használatával. |
|
Videoazonosító
|
video_id | string |
A video_id dokumentum létrehozásakor használandó feltöltött videó azonosítója |
Videók listázása
Az entitáson elérhető videók listájának fogadása. Felvehet új videókat a mobilalkalmazásba vagy a GetAcceptbe.
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
videos
|
videos | array of object | |
|
Szerkeszthető
|
videos.editable | boolean | |
|
Közzétett
|
videos.published | boolean | |
|
mentett
|
videos.saved | boolean | |
|
thumb_url
|
videos.thumb_url | string | |
|
video_id
|
videos.video_id | string | |
|
video_title
|
videos.video_title | string | |
|
video_type
|
videos.video_type | string | |
|
video_url
|
videos.video_url | string |
Triggerek
| Dokumentum aláírása |
Eseményindítók, ha az összes aláíró fél aláírta a dokumentumot |
| Dokumentum elutasítása |
Eseményindítók, ha egy dokumentumot bármelyik címzett elutasított |
| Dokumentum áttekintése |
Eseményindítók, ha a címzettek bármelyike áttekintett egy dokumentumot |
| Feliratkozás dokumentumeseményekre |
Ez a hívás új előfizetést hoz létre. A válasz egy tömbbe lesz csomagolva, még a REST-horogszabványoknak megfelelő egyetlen objektum esetében is.
|
Dokumentum aláírása
Eseményindítók, ha az összes aláíró fél aláírta a dokumentumot
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Minden entitásfelhasználó
|
global | boolean |
Ha a webhook minden entitásfelhasználó eseményeit észleli. |
|
|
E-mail hiba
|
notification_email | string |
Ha az esemény meghiúsul, küldjön egy értesítést erre az e-mailre a feladó helyett |
|
|
Hasznos teher
|
payload | string |
További hasznos adatok közzéteendő adatai |
Válaszok
Webhook hasznos adat
- Webhook
- Webhook
Dokumentum elutasítása
Eseményindítók, ha egy dokumentumot bármelyik címzett elutasított
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Minden entitásfelhasználó
|
global | boolean |
Ha a webhook minden entitásfelhasználó eseményeit észleli. |
|
|
E-mail hiba
|
notification_email | string |
Ha az esemény meghiúsul, küldjön egy értesítést erre az e-mailre a feladó helyett |
|
|
Hasznos teher
|
payload | string |
További hasznos adatok közzéteendő adatai |
Válaszok
Webhook hasznos adat
- Webhook
- Webhook
Dokumentum áttekintése
Eseményindítók, ha a címzettek bármelyike áttekintett egy dokumentumot
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Minden entitásfelhasználó
|
global | boolean |
Ha a webhook minden entitásfelhasználó eseményeit észleli. |
|
|
E-mail hiba
|
notification_email | string |
Ha az esemény meghiúsul, küldjön egy értesítést erre az e-mailre a feladó helyett |
|
|
Hasznos teher
|
payload | string |
További hasznos adatok közzéteendő adatai |
Válaszok
Webhook hasznos adat
- Webhook
- Webhook
Feliratkozás dokumentumeseményekre
Ez a hívás új előfizetést hoz létre. A válasz egy tömbbe lesz csomagolva, még a REST-horogszabványoknak megfelelő egyetlen objektum esetében is.
Events
-
document.created– A dokumentum létrejön -
document.sent- A dokumentum elküldve -
document.viewed- A dokumentum elküldve -
document.signed- A dokumentum aláírása -
document.approved- A dokumentum jóvá van hagyva -
document.expired- A dokumentum lejárt -
document.rejected- A dokumentum elutasítva -
document.downloaded– A dokumentum letöltése -
document.printed- A dokumentum nyomtatása -
document.forwarded- A dokumentum továbbítása -
document.partially_signed- A dokumentumot részben aláírták -
document.commented- A dokumentum megjegyzésben van -
document.hardbounced- A dokumentum keményen van bejelentve -
document.imported– A dokumentum importálása
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Esemény kiválasztása
|
event | True | string |
Eseményindító |
|
Minden entitásfelhasználó
|
global | boolean |
Ha a webhook minden entitásfelhasználó eseményeit észleli. |
|
|
E-mail hiba
|
notification_email | string |
Ha az esemény meghiúsul, küldjön egy értesítést erre az e-mailre a feladó helyett |
|
|
Hasznos teher
|
payload | string |
További hasznos adatok közzéteendő adatai |
Válaszok
Webhook hasznos adat
- Webhook
- Webhook
Definíciók
Attachment
Dokumentummelléklet
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Címzettek elérése
|
access_recipient_names | array of string |
A melléklethez hozzáféréssel rendelkező címzettek |
|
Description
|
attachment_description | string |
A melléklet leírása |
|
URL-cím letöltése
|
attachment_download_url | string |
A melléklet letöltéséhez tartozó URL-cím |
|
Fájlkiterjesztés
|
attachment_extension | string |
A melléklet fájlkiterjesztése |
|
Filename
|
attachment_filename | string |
A melléklet fájlneve |
|
azonosító
|
attachment_id | string |
A melléklet azonosítója |
|
Előnézet URL-címe
|
attachment_preview_url | string |
Belső URL-cím a melléklet előnézetének megtekintéséhez |
|
Cím
|
attachment_title | string |
A melléklet címe |
|
Típus
|
attachment_type | string |
A melléklet típusa |
|
URL
|
attachment_url | string |
A melléklet URL-címe |
|
Utolsó nézet
|
last_attachment_view | string |
A melléklet legutóbbi megtekintésének dátuma és időpontja |
|
Erősen korlátozott hozzáférés
|
restrict_access | boolean |
A melléklet korlátozott hozzáféréssel rendelkezik |
Attachments
Mellékletlista
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
attachments
|
attachments | array of Attachment |
Érintkezés
Minden egyedi e-mail cím (vagy mobilszám) névjegyként van definiálva.
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Cégazonosító
|
company_id | string |
Cégazonosító |
|
Céges embléma
|
company_logo_url | string |
Céges embléma |
|
Cég neve
|
company_name | string |
A kapcsolattartó cégneve |
|
Cégszám
|
company_number | string |
A kapcsolattartó cégének száma |
|
Kapcsolattartó azonosítója
|
contact_id | string |
Kapcsolattartó azonosítója |
|
Létrehozott
|
created_at | string |
A kapcsolattartó létrehozásának dátuma |
|
Documents
|
document_count | number |
Névjegyhez tartozó dokumentumok száma |
|
Kapcsolattartási e-mail-cím
|
string |
A létrehozott dokumentum neve |
|
|
Keresztnév
|
first_name | string |
A partner utóneve |
|
Teljes név
|
fullname | string |
A partner teljes neve |
|
Társadalmi nem
|
gender | string |
A címzett neme |
|
Vezetéknév
|
last_name | string |
A partner vezetékneve |
|
Mobil
|
mobile | string |
A kapcsolattartó mobilszáma |
|
Megjegyzés:
|
note | string |
A partner megjegyzése |
|
Hüvelykujj URL-címe
|
thumb_url | string |
A partner hüvelykujjÁNAK URL-címe |
|
Cím
|
title | string |
A kapcsolattartó címe |
Contacts
Partnerlista
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
kapcsolattartók
|
contacts | array of Contact |
Dokumentum
A dokumentum egy vagy több feltöltött fájl(ok), amelyet egy felhasználó által létrehozott egy vagy több címzettnek kell elküldeni.
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Címkék
|
tags | string |
Dokumentumcímkék |
|
Automatikus csevegőszöveg
|
auto_comment_text | string |
Automatikus csevegőszöveg |
|
Cégnév
|
company_name | string |
Cégnév |
|
Létrehozás időpontja:
|
created_at | string |
A dokumentum létrehozásakor |
|
URL-cím letöltése
|
download_url | string |
Aláírt dokumentum letöltésének URL-címe |
|
E-mail üzenet
|
email_send_message | string |
E-mail küldése |
|
E-mail tárgy
|
email_send_subject | string |
E-mail tárgyának szövege |
|
Lejárati dátum
|
expiration_date | string |
Dokumentum lejárati dátuma |
|
Külső ügyfélazonosító
|
external_client_id | string | |
|
Külső szerkesztő azonosítója
|
external_editor_id | string |
Azonosító a külső szerkesztőben |
|
Külső szerkesztő típusa
|
external_editor_type | string | |
|
Külső ID
|
external_id | string | |
|
Mezőszám
|
field_count | integer |
A dokumentum mezőinek száma |
|
azonosító
|
id | string | |
|
Automatikus megjegyzés
|
is_auto_comment | boolean |
Ha az automatikus csevegési megjegyzés engedélyezve van |
|
Automatikus megjegyzés e-mail
|
is_auto_comment_email | boolean |
Ha az automatikus csevegési e-mail engedélyezve van |
|
Címzett azonosítása
|
is_identify_recipient | boolean |
Ha a dokumentum engedélyezte a címzett azonosítását |
|
Privát
|
is_private | boolean |
Ha a dokumentum privát |
|
Emlékeztetők küldése
|
is_reminder_sending | boolean |
Ha az automatikus emlékeztetők engedélyezve vannak |
|
Ütemezett küldés
|
is_scheduled_sending | boolean |
Ha a dokumentum ütemezett küldést |
|
Önaláírás
|
is_selfsign | boolean |
Ha a dokumentumot önaláírta a feladó |
|
Aláírt
|
is_signed | boolean |
Ha a dokumentum aláírása megtörtént |
|
Aláírható dokumentum
|
is_signing | boolean |
Ha a dokumentum aláírható |
|
Kézzel írt aláírás
|
is_signing_biometric | boolean |
Ha a kézzel írt aláírás engedélyezve van |
|
Aláírásátvitel engedélyezése
|
is_signing_forward | boolean |
Ha engedélyezve van az aláírási jogosultságok átadása |
|
Aláírási sorrend
|
is_signing_order | boolean |
Ha a címzett aláírási rendelése engedélyezve van |
|
Videóval rendelkezik
|
is_video | boolean |
Ha a dokumentum bevezető videóval rendelkezik |
|
Név
|
name | string |
Dokumentum neve |
|
Szülőazonosító
|
parent_id | string |
Az előző dokumentumverzió azonosítója |
|
Előnézet URL-címe
|
preview_url | string |
Hivatkozás a dokumentum belső előnézetére |
|
recipients
|
recipients | array of Recipient | |
|
Ütemezett küldési idő
|
scheduled_sending_time | string |
Amikor a dokumentum küldésre lett ütemezve |
|
Küldés dátuma
|
send_date | string |
Dokumentumküldés dátuma |
|
Feladó e-mailje
|
sender_email | string |
Feladó felhasználójának e-mail-címe |
|
Feladó neve
|
sender_name | string |
Feladó felhasználójának neve |
|
Feladó hüvelykujjÁNAK URL-címe
|
sender_thumb_url | string |
A feladó felhasználójának hüvelykujj képe |
|
Aláírás dátuma
|
sign_date | string |
Dokumentum aláírásának dátuma |
|
Státusz
|
status | string |
Dokumentum aktuális állapota |
|
Hüvelykujj URL-címe
|
thumb_url | string |
Dokumentum hüvelykujj képe |
|
Típus
|
type | string |
Dokumentum típusa |
|
Egyedi azonosító
|
unique_id | integer |
Dokumentum egyedi azonosítója |
|
Felhasználói azonosító
|
user_id | string |
A feladó felhasználójának azonosítója |
|
Érték
|
value | integer |
Dokumentum értéke |
Documents
Dokumentumlista
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
tags
|
tags | string | |
|
company_name
|
company_name | string | |
|
létrehozás_időpontja
|
created_at | string | |
|
expiration_date
|
expiration_date | string | |
|
azonosító
|
id | string | |
|
is_private
|
is_private | boolean | |
|
is_signing
|
is_signing | boolean | |
|
név
|
name | string | |
|
sender_name
|
sender_name | string | |
|
sender_thumb
|
sender_thumb | string | |
|
állapot
|
status | string | |
|
típus
|
type | string | |
|
value
|
value | integer |
Szerkesztőmező
Szerkesztőmező részletei
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
azonosító
|
id | string |
azonosító |
|
Címke
|
input_settings.label | string |
Címke |
|
Beállítások
|
input_settings.options | array of string |
Beállítások |
|
Kötelező
|
input_settings.required | boolean |
Kötelező |
|
Típus
|
input_settings.type | string |
Típus |
|
Címzett azonosítója
|
recipient_id | string |
Címzett azonosítója |
|
Típus
|
type | string |
Típus |
|
Felhasználói azonosító
|
user_id | string |
Felhasználói azonosító |
szakterület
Mező részletei
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Cégnév
|
company_name | string |
Cégnév |
|
Cégszám
|
company_number | string |
Cégszám |
|
Mezőazonosító
|
field_id | string |
Mezőazonosító |
|
Címke
|
field_label | string |
Címke |
|
Beállítások
|
field_options | array of object |
Beállítások |
|
Érték
|
field_options.value | string | |
|
Típus
|
field_type | string |
Típus |
|
Érték
|
field_value | string |
Érték |
|
is_collectable
|
is_collectable | boolean |
Gyűjtőmező |
|
is_editable
|
is_editable | boolean |
Szerkeszthető mező |
|
is_required
|
is_required | boolean |
Kötelezően kitöltendő mező |
|
Oldalazonosító
|
page_id | string |
Oldalazonosító |
|
Címzett azonosítója
|
recipient_id | string |
Címzett azonosítója |
|
Címzett neve
|
recipient_name | string |
Címzett neve |
|
Szerepkör neve
|
role_name | string |
Szerepkör neve |
Fields
Mezőlista
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
editor_fields
|
editor_fields | array of EditorField | |
|
Mezők
|
fields | array of Field |
PricingColumn
Tarifatábla oszlopa
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
azonosító
|
column_id | string |
azonosító |
|
Megjelenítendő név
|
display_name | string |
Megjelenítendő név |
|
Enabled
|
enabled | boolean |
Enabled |
|
Név
|
name | string |
Név |
Tarifacsomag
Díjszabási tábla szakasz
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
columns
|
columns | array of PricingColumn | |
|
Megjelenítendő név
|
display_name | string |
Megjelenítendő név |
|
Név
|
name | string |
Név |
|
azonosító
|
section_id | string |
azonosító |
Tarifatábla
Díjszabási táblázat
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Valuta
|
currency_settings.currency | string |
Valuta |
|
Helyszín
|
currency_settings.locale | string |
Helyszín |
|
Előre kiszámított összegek
|
pre_calculated | boolean |
Előre kiszámított összegek |
|
Szakaszok
|
sections | array of PricingSection | |
|
azonosító
|
table_id | string |
Táblaazonosító |
Tarifatáblák
Tarifatáblák
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
pricing_tables
|
pricing_tables | array of PricingTable |
Recipient
A dokumentumhoz csatlakoztatott minden egyedi e-mail-cím (vagy mobilszám) címzett.
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Cég neve
|
company_name | string |
A címzett cégneve |
|
Cégszám
|
company_number | string |
A címzett céges száma |
|
Dokumentum URL-címe
|
document_url | string |
A címzett egyedi URL-címe a megtekintéshez/aláíráshoz |
|
Címzett e-mail címe
|
string |
A címzett e-mail-címe |
|
|
Keresztnév
|
first_name | string |
A címzett utóneve |
|
Teljes név
|
fullname | string |
A címzett teljes neve |
|
Társadalmi nem
|
gender | string |
A címzett neme |
|
azonosító
|
id | string |
A címzett azonosítója |
|
Vezetéknév
|
last_name | string |
A címzett vezetékneve |
|
Mobil
|
mobile | string |
A címzett mobilszáma |
|
Megjegyzés:
|
note | string |
A címzett megjegyzése |
|
Aláírási rendelés száma
|
order_num | string |
A címzett aláírási sorrendje |
|
Státusz
|
status | string |
A címzett állapota |
|
Hüvelykujj URL-címe
|
thumb_url | string |
A címzett hüvelykujjÁNAK URL-címe |
|
Cím
|
title | string |
A címzett címe |
Címzettek
Címzettek listája
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
recipients
|
recipients | array of Recipient |
User
A felhasználót az e-mail-címe határozza meg, és egy vagy több entitáshoz kapcsolódik.
Felhasználói szerepkörök
Adminisztrátor:
- Az összes dokumentum megtekintése
- Az összes dokumentum szerkesztése
- Entitásbeállítások, adatok és számlázás módosítása
- Új felhasználók hozzáadása az entitáshoz
- Entitásszerepkörök hozzárendelése
Menedzser:
- Csoportdokumentumok megtekintése
- Az összes dokumentum szerkesztése
- Új felhasználók hozzáadása az entitáshoz
Entitás
Az entitás a legfelső csomópont, és az összes felhasználó és a kapcsolódó dokumentum egy entitáshoz csatlakozik. Az entitások gyakran megegyeznek egy nagy szervezet vállalatával, országával vagy részlegével.
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Alkalmazás mód
|
app_mode | string | |
|
disallow_create
|
disallow_create | boolean | |
|
Email
|
string |
A felhasználó e-mail-címe |
|
|
Entitás azonosítója
|
entity_id | string | |
|
Entitásnév
|
entity_name | string | |
|
Keresztnév
|
first_name | string |
A felhasználó utóneve |
|
azonosító
|
id | string |
A felhasználó azonosítója |
|
Nyelv
|
language | string | |
|
Vezetéknév
|
last_name | string |
A felhasználó vezetékneve |
|
mobil
|
mobile | string |
Mobilszám nemzetközi formátumban |
|
Megjegyzés:
|
note | string |
Nem kötelező belső megjegyzés a felhasználó számára |
|
Telefonszám
|
phone | string |
Telefonszám nemzetközi formátumban |
|
Role
|
role | string | |
|
Meghívás küldésének kihagyása
|
skip_invitation | boolean | |
|
Státusz
|
status | string | |
|
Csapat azonosítója
|
team_id | string | |
|
Hüvelykujj URL-címe
|
thumb_url | string | |
|
Timezone
|
timezone | string | |
|
Cím
|
title | string |
A felhasználó címe, pl. vezérigazgató, értékesítési vezető |
Felhasználók
Felhasználói lista
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
users
|
users | array of object | |
|
Email
|
users.email | string | |
|
Keresztnév
|
users.first_name | string | |
|
Utolsó bejelentkezés
|
users.last_login | string | |
|
Vezetéknév
|
users.last_name | string | |
|
Felhasználónév
|
users.name | string | |
|
Role
|
users.role | string | |
|
Státusz
|
users.status | string | |
|
Csapat neve
|
users.team_name | string | |
|
Felhasználói azonosító
|
users.user_id | string |
Webhook
Webhook hasznos adat
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Egyéni mezők
|
custom_fields | object | |
|
Dokumentum
|
document | Document |
A dokumentum egy vagy több feltöltött fájl(ok), amelyet egy felhasználó által létrehozott egy vagy több címzettnek kell elküldeni. |
|
Entitás egyéni tartománya
|
entity.custom_domain | string |
Egyéni tartománybeállítás entitáshoz |
|
Alapértelmezett e-mail-üzenet
|
entity.email_send_message | string |
Alapértelmezett e-mail-üzenet |
|
Alapértelmezett e-mail-tárgy
|
entity.email_send_subject | string |
Alapértelmezett e-mail-tárgy |
|
Entitás altartománya
|
entity.sub_domain | string |
Az entitás altartománya |
|
Esemény neve
|
event | string | |
|
Eseményművelet
|
event_action | string | |
|
Esemény típusa
|
event_type | string | |
|
Recipient
|
recipient | Recipient |
A dokumentumhoz csatlakoztatott minden egyedi e-mail-cím (vagy mobilszám) címzett. |
|
Előfizetés azonosító
|
subscription_id | string |