GetAccept
GetAccept bietet eine Vertriebsaktivierungsplattform zum Entwerfen, Senden, Bewerben, Nachverfolgen und E-Signieren von Verkaufsdokumenten, nutzung von Verkaufssicherheiten, Vertragsverwaltung, Vorschlägen und elektronischen Signaturen an einem Zentralen Ort.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | GetAccept-API-Team |
| URL | https://app.getaccept.com/api |
| integrations@getaccept.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | GetAccept, Inc. |
| Webseite | https://www.getaccept.com |
| Datenschutzrichtlinie | https://www.getaccept.com/privacy-policy |
| Kategorien | Vertrieb und CRM; Produktivität |
GetAccept bietet eine Vertriebsaktivierungsplattform zum Entwerfen, Senden, Bewerben, Nachverfolgen und E-Signieren von Verkaufsdokumenten, nutzung von Verkaufssicherheiten, Vertragsverwaltung, Vorschlägen und elektronischen Signaturen an einem Zentralen Ort. Dieser Connector hilft ihnen, Ihre Workflows für die Dokumentspeicherung, das Abrufen, die Aufgabenzuweisung und angepasste Benachrichtigungen zu automatisieren.
Voraussetzungen
Für diese Verbindung ist ein GetAccept-Konto erforderlich. Wechseln Sie zu getaccept.com , um ein kostenloses Konto zu registrieren.
Wie erhalten Sie Anmeldeinformationen?
Es ist nur ein gültiges GetAccept-Konto erforderlich, da OAuth2 verwendet wird, um den aktuellen angemeldeten Benutzer in GetAccept zu authentifizieren.
Bekannte Probleme und Einschränkungen
Wenden Sie sich an unseren [mailto:support@getaccept.com](technischen Support) für alle integrationsbezogenen Probleme.
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen von Benutzerdetails |
Dieser Aufruf gibt Details eines einzelnen Benutzers zurück. Empfangen von Details und verfügbaren Entitäten des aktuellen authentifizierten Benutzers mithilfe der Benutzer-ID |
| Abrufen von Dokumentanlagen |
Abrufen von Dokumentanlagen durch Angeben einer Dokument-ID. |
| Abrufen von Dokumentdetails |
Rufen Sie Dokumentdetails ab, indem Sie eine Dokument-ID angeben. |
| Abrufen von Dokumentempfängern |
Dient zum Abrufen einer Liste von Empfängern für ein bestimmtes Dokument. |
| Abrufen von Dokumentfeldern |
Dient zum Abrufen einer Liste von Feldern für ein Dokument oder eine Vorlage. Kann sowohl vor als auch nach der Unterzeichnung eines Dokuments verwendet werden. |
| Abrufen von Vorlagenpreistabellen |
Erhalten Sie eine Liste von Preistabellenelementen für eine bestimmte Vorlage. |
| Aktualisieren des Dokumentablaufs |
Verwenden Sie diese Methode, um das Ablaufdatum und die Uhrzeit für ein Dokument zu aktualisieren. |
| Anlagen auflisten |
Empfangen einer Liste der verfügbaren Anlagen. Sie können neue Anlagen in GetAccept mithilfe eines neuen Dokuments hinzufügen. |
| Benutzer auflisten |
Abrufen einer Liste aktiver Benutzer für die aktuelle authentifizierte Entität |
| Benutzer erstellen |
Dadurch wird ein neuer Kontakt in der Datenbank für die aktuelle Entität erstellt. |
| Dokument herunterladen |
Dokumentdatei kann immer heruntergeladen werden, aber höchstwahrscheinlich möchten Sie sie herunterladen, wenn sie den Status "Signiert" hat. Sie können auswählen, dass sie eine Download-URL erhalten oder die Binärdatei abrufen möchten. Die Download-URL kann 10 Minuten nach der Anforderung zugegriffen werden. |
| Dokumente auflisten |
Abrufen einer Liste der verfügbaren Dokumente |
| Erstellen und Senden von Dokumenten oder Vorlagen |
Sie müssen ein Dokument erstellen, damit es an einen Empfänger gesendet werden kann. Beim Erstellen eines Dokuments können Sie auf zuvor hochgeladene Dateien mit file_id verweisen, oder Sie können auswählen, ein Dokument zu erstellen und die Dateien im API-Beitrag hochzuladen. Sie können eine Datei nur hochladen, wenn Sie eine Datei in die POST-Datei zum Erstellen eines Dokuments einschließen. Verwenden Sie entweder file_ids Parameter, um vorhandene hochgeladene Dateien zu verwenden, file_content, um das Dokument als base64-codierte Zeichenfolge zu senden oder einen mehrteiligen Beitrag mit dem Dateiparameter durchzuführen. Alle Empfänger müssen entweder über eine gültige E-Mail oder eine Mobiltelefonnummer verfügen. Alle Ereignisse werden mithilfe der IP-Adresse des Anforderers aufgezeichnet. Sie können dies über die Kopfzeile CLIENT_IP, die die öffentliche IP-Adresse der Endbenutzer enthält, überschreiben. |
| Hochladen einer Anlage |
Sie können Anlagendateien hochladen, um sie in von Ihnen gesendete Dokumente einzuschließen. Die erfolgreiche Anforderung gibt den attachment_id zurück. Verwenden Sie attachment_id, um einem Dokument eine Anlage zuzuweisen. |
| Hochladen einer Dokumentdatei |
Sie können jeweils eine Datei hochladen und eine Datei-ID abrufen. Die Datei-ID wird verwendet, um eine Datei mit einem GetAccept-Dokument zu verbinden, das an Empfänger gesendet wird. Wenn Sie mutliple Dateien hochladen möchten, führen Sie mehrere POST-Dateien aus. Wir akzeptieren dateien nur bis zu 10 MB als Standard. Hochgeladene Datei muss innerhalb von 48 Stunden nach dem Hochladen in ein Dokument importiert/hinzugefügt werden. Wir empfehlen Ihnen, PDF-Dateien hochzuladen, um das gleiche Aussehen beim Senden zu gewährleisten. Andere Dateitypen können konvertiert werden, z. B.: Mirosoft Office: doc, docx, xl, xls, xlsx, ppt, pptx Mac: numbers, key Images: jpg, jpeg, png Other: html, tex, csv |
| Hochladen eines Videos |
Sie können Anlagendateien hochladen, um sie in von Ihnen gesendete Dokumente einzuschließen. Die erfolgreiche Anforderung gibt den attachment_id zurück. Verwenden Sie attachment_id, um einem Dokument eine Anlage zuzuweisen. |
| Kontakt erstellen |
Dadurch wird ein neuer Kontakt in der Datenbank für die aktuelle Entität erstellt. |
| Kontakte auflisten |
Empfangen einer Liste der verfügbaren Kontakte für die aktuelle Entität. Alle als Empfänger hinzugefügten Kontakte werden als Kontakt gespeichert und stehen für die spätere Verwendung in dieser Entität zur Verfügung. |
| Listenvorlagen |
Erhalten Sie eine Liste der verfügbaren Dokumentvorlagen. Sie können neue Vorlagen im Abschnitt "Vorlagen" in "GetAccept" hinzufügen. |
| Videos auflisten |
Erhalten Sie eine Liste der verfügbaren Videos für die Entität. Sie können neue Videos in der mobilen App oder in GetAccept hinzufügen. |
| Vorhandenes Dokument senden |
Wenn Sie ein Dokument über GetAccept senden, senden wir eine E-Mail an alle Empfänger, die jeweils einen eindeutigen, gesicherten Link enthalten. Dieser API-Aufruf löst die Aktion zum Senden von Dokumenten aus und kann nur für Dokumente mit document_status = Entwurf ausgeführt werden. Das Dokument wird an Empfänger gesendet, die Sie beim Erstellen angegeben haben. Wenn ein Dokument mithilfe der Selbstsignieroption erstellt wurde, wird es auch vom authentifizierten oder angegebenen Benutzer vor dem Senden selbstsigniert. |
| Vorlagenfelder abrufen |
Empfangen einer Liste von Feldern für eine bestimmte Vorlage. |
| Vorlagenrollen abrufen |
Empfangen einer Liste von Rollen für eine bestimmte Vorlage. |
Abrufen von Benutzerdetails
Dieser Aufruf gibt Details eines einzelnen Benutzers zurück. Empfangen von Details und verfügbaren Entitäten des aktuellen authentifizierten Benutzers mithilfe der Benutzer-ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
userId | True | string |
Benutzer-ID |
Gibt zurück
Ein Benutzer wird durch die E-Mail-Adresse definiert und ist mit einer oder mehreren Entitäten verbunden.
Benutzerrollen
Administrator:
- Alle Dokumente anzeigen
- Alle Dokumente bearbeiten
- Ändern von Entitätseinstellungen, Informationen und Abrechnungen
- Hinzufügen neuer Benutzer zur Entität
- Zuweisen von Entitätsrollen
Manager:
- Anzeigen von Teamdokumenten
- Alle Dokumente bearbeiten
- Hinzufügen neuer Benutzer zur Entität
Entität
Eine Entität ist der oberste Knoten, und alle Benutzer und die entsprechenden Dokumente sind mit einer Entität verbunden. Eine Entität ist häufig mit einem Unternehmen, einem Land oder einer Abteilung in einer großen Organisation identisch.
- Benutzer
- User
Abrufen von Dokumentanlagen
Abrufen von Dokumentanlagen durch Angeben einer Dokument-ID.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Dokument-ID |
Gibt zurück
Anlagenliste
- Attachments
- Attachments
Abrufen von Dokumentdetails
Rufen Sie Dokumentdetails ab, indem Sie eine Dokument-ID angeben.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Dokument-ID |
Gibt zurück
Ein Dokument ist eine oder mehrere hochgeladene Dateien, die an einen oder mehrere Empfänger gesendet werden sollen, die von einem Benutzer erstellt wurden.
- Dokument
- Document
Abrufen von Dokumentempfängern
Dient zum Abrufen einer Liste von Empfängern für ein bestimmtes Dokument.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Dokument-ID |
Gibt zurück
Empfängerliste
- Empfänger
- Recipients
Abrufen von Dokumentfeldern
Dient zum Abrufen einer Liste von Feldern für ein Dokument oder eine Vorlage. Kann sowohl vor als auch nach der Unterzeichnung eines Dokuments verwendet werden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Dokument-ID |
Gibt zurück
Feldliste
- Felder
- Fields
Abrufen von Vorlagenpreistabellen
Erhalten Sie eine Liste von Preistabellenelementen für eine bestimmte Vorlage.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vorlagen-ID
|
templateId | True | string |
Vorlagen-ID |
Gibt zurück
Preistabellen
- Pricing
- PricingTables
Aktualisieren des Dokumentablaufs
Verwenden Sie diese Methode, um das Ablaufdatum und die Uhrzeit für ein Dokument zu aktualisieren.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Dokument-ID |
|
Ablaufdatum
|
expiration_date | date-time |
Datum und Uhrzeit des Ablaufs des Dokuments (UTC) |
|
|
Benachrichtigung senden
|
send_notification | boolean |
Sollte eine Benachrichtigung über das Update an Empfänger gesendet werden |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Der Status
|
status | integer |
Status des Updates |
Anlagen auflisten
Empfangen einer Liste der verfügbaren Anlagen. Sie können neue Anlagen in GetAccept mithilfe eines neuen Dokuments hinzufügen.
Gibt zurück
Anlagenliste
- Attachments
- Attachments
Benutzer auflisten
Abrufen einer Liste aktiver Benutzer für die aktuelle authentifizierte Entität
Gibt zurück
Benutzerliste
- Benutzer
- Users
Benutzer erstellen
Dadurch wird ein neuer Kontakt in der Datenbank für die aktuelle Entität erstellt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
company_name
|
company_name | string |
Name des zugeordneten Unternehmens |
|
|
company_number
|
company_number | string |
Zugeordnete Firmennummer |
|
|
E-Mail
|
string |
E-Mail-Adresse des Kontakts |
||
|
first_name
|
first_name | string |
Vorname des Kontakts |
|
|
Vollständiger Name
|
fullname | string |
Wird verwendet, um den vollständigen Namen anstelle des Vor-/Nachnamens anzugeben. |
|
|
last_name
|
last_name | string |
Nachname des Kontakts |
|
|
mobile
|
mobile | string |
Mobilnummer im internationalen Format |
|
|
Anmerkung
|
note | string |
Optionale interne Notiz für Kontakt |
|
|
phone
|
phone | string |
Telefonnummer im internationalen Format |
|
|
title
|
title | string |
Der Titel des Kontakts, z. B. CEO, Vertriebsleiter |
Gibt zurück
Ein Benutzer wird durch die E-Mail-Adresse definiert und ist mit einer oder mehreren Entitäten verbunden.
Benutzerrollen
Administrator:
- Alle Dokumente anzeigen
- Alle Dokumente bearbeiten
- Ändern von Entitätseinstellungen, Informationen und Abrechnungen
- Hinzufügen neuer Benutzer zur Entität
- Zuweisen von Entitätsrollen
Manager:
- Anzeigen von Teamdokumenten
- Alle Dokumente bearbeiten
- Hinzufügen neuer Benutzer zur Entität
Entität
Eine Entität ist der oberste Knoten, und alle Benutzer und die entsprechenden Dokumente sind mit einer Entität verbunden. Eine Entität ist häufig mit einem Unternehmen, einem Land oder einer Abteilung in einer großen Organisation identisch.
- Benutzer
- User
Dokument herunterladen
Dokumentdatei kann immer heruntergeladen werden, aber höchstwahrscheinlich möchten Sie sie herunterladen, wenn sie den Status "Signiert" hat.
Sie können auswählen, dass sie eine Download-URL erhalten oder die Binärdatei abrufen möchten.
Die Download-URL kann 10 Minuten nach der Anforderung zugegriffen werden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Dokument-ID |
|
Direktes Zurückgeben der Binärdatei
|
direct | string |
Direktes Zurückgeben der Binärdatei |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
document_url
|
document_url | string | |
|
file
|
file | string |
Dokumente auflisten
Abrufen einer Liste der verfügbaren Dokumente
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Filterliste nach Status
|
filter | string |
Filterliste nach Status |
|
|
Sortieren von Ergebnissen
|
sort_by | string |
Sortieren von Ergebnissen |
|
|
Sortierreihenfolge der Ergebnisse
|
sort_order | string |
Sortierreihenfolge der Ergebnisse |
|
|
Einschließen von Dokumenten von Teammitgliedern
|
showteam | boolean |
Einschließen von Dokumenten von Teammitgliedern |
|
|
Alle Dokumente aus der Entität einschließen
|
showall | boolean |
Alle Dokumente aus der Entität einschließen |
|
|
Externe ID
|
external_id | string |
Eine externe ID ist ein benutzerdefiniertes Feld, das einen eindeutigen Datensatzbezeichner aus einem System außerhalb von GetAccept enthalten kann. |
|
|
Offset
|
offset | number |
Liste vom Datensatz x bis zum Limit starten |
|
|
Limit
|
limit | number |
Anzahl der zu listenden Datensätze |
Gibt zurück
Dokumentliste
- Gegenstände
- Documents
Erstellen und Senden von Dokumenten oder Vorlagen
Sie müssen ein Dokument erstellen, damit es an einen Empfänger gesendet werden kann. Beim Erstellen eines Dokuments können Sie auf zuvor hochgeladene Dateien mit file_id verweisen, oder Sie können auswählen, ein Dokument zu erstellen und die Dateien im API-Beitrag hochzuladen. Sie können eine Datei nur hochladen, wenn Sie eine Datei in die POST-Datei zum Erstellen eines Dokuments einschließen.
Verwenden Sie entweder file_ids Parameter, um vorhandene hochgeladene Dateien zu verwenden, file_content, um das Dokument als base64-codierte Zeichenfolge zu senden oder einen mehrteiligen Beitrag mit dem Dateiparameter durchzuführen.
Alle Empfänger müssen entweder über eine gültige E-Mail oder eine Mobiltelefonnummer verfügen.
Alle Ereignisse werden mithilfe der IP-Adresse des Anforderers aufgezeichnet. Sie können dies über die Kopfzeile CLIENT_IP, die die öffentliche IP-Adresse der Endbenutzer enthält, überschreiben.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID
|
id | string |
Anlagen-ID, die von der Liste oder nach dem Upload empfangen wurde |
|
|
Ansicht erforderlich
|
require_view | boolean |
Anfordern, dass der Empfänger die Anlage anzeigt |
|
|
Typ
|
type | string |
Datei oder extern, bei der es sich bei der Datei um eine hochgeladene Datei handelt und extern eine Verknüpfung zu einer externen Datei ist |
|
|
Feld-ID
|
id | string |
ID des benutzerdefinierten Vorlagenfelds |
|
|
Feldname
|
name | string |
Name des benutzerdefinierten Vorlagenfelds |
|
|
Feldwert
|
value | string |
Wert des benutzerdefinierten Vorlagenfelds |
|
|
Währung
|
currency | string |
Währung, z. B. SEK |
|
|
Gebietsschema
|
locale | string |
Gebietsschema, z. B. sv-SE |
|
|
Anzeigename
|
display_name | string |
Anzeigename der Preistabelle |
|
|
Externe ID
|
external_id | string |
Externe ID zur Darstellung des Zusammenfassungsobjekts innerhalb eines Drittanbietersystems |
|
|
Tabellenkennung (ID)
|
id | string |
Tabellenkennung (ID) |
|
|
Berechnete Summen
|
pre_calculated | boolean |
Wenn Die Summen der Preistabellen vorab berechnet werden sollen |
|
|
Anzeigename
|
display_name | string |
Anzeigename der Preistabelle |
|
|
ID
|
id | string |
Abschnitts-ID |
|
|
Rows
|
rows |
Array mit Werteobjekt mit Array von column_id, Wert |
||
|
Enabled
|
enabled | boolean |
Wenn abschnittsrabatt aktiviert werden soll |
|
|
Pauschalgebühr
|
flat_fee | boolean |
Wenn Der Abschnitt die Nutzung von Pauschalgebührenrabatten verwenden soll |
|
|
Rabattwert
|
value | string |
Der Wert für den Abschnittsrabatt |
|
|
Enabled
|
enabled | boolean |
Wenn der Abschnittspreis aktiviert sein soll |
|
|
Pauschalgebühr
|
flat_fee | boolean |
Wenn Der Abschnitt die Pauschalgebühr verwenden soll |
|
|
Preiswert
|
value | string |
Der Wert für den Abschnittspreis |
|
|
Enabled
|
enabled | boolean |
Wenn Abschnittssteuer aktiviert werden soll |
|
|
Pauschalgebühr
|
flat_fee | boolean |
Wenn Der Abschnitt die Pauschalgebühren verwenden soll |
|
|
Steuerwert
|
value | string |
Der Wert für die Abschnittssteuer |
|
|
Enabled
|
enabled | boolean |
Wenn der Preistabellenrabatt aktiviert werden soll |
|
|
Pauschalgebühr
|
flat_fee | boolean |
Wenn die Preistabelle mit Pauschalgebührrabatten verwendet werden soll |
|
|
Rabattwert
|
value | string |
Der Wert für den Sammelrabatt |
|
|
Enabled
|
enabled | boolean |
Wenn der Preistabellenpreis aktiviert sein soll |
|
|
Pauschalgebühr
|
flat_fee | boolean |
Wenn die Preistabelle die Pauschalgebühr verwenden soll |
|
|
Preiswert
|
value | string |
Der Wert für den Sammelpreis |
|
|
Enabled
|
enabled | boolean |
Wenn die Preistabellensteuer aktiviert werden soll |
|
|
Pauschalgebühr
|
flat_fee | boolean |
Wenn die Preistabelle die Pauschalgebühren verwenden soll |
|
|
Wert
|
value | string |
Der Wert für die Sammelsteuer |
|
|
Ablaufdatum
|
expiration_date | date-time |
Datum und Uhrzeit des Ablaufs des Dokuments |
|
|
Externe ID
|
external_id | string |
Id des externen Systems zur Identifizierung |
|
|
Dateiinhalt
|
file_content | string |
Base64-codierter Dateiinhalt |
|
|
Datei-IDs
|
file_ids | string |
Durch Trennzeichen getrennte, eindeutige Datei-IDs, die beim Hochladen von Dateien empfangen werden |
|
|
Dateiname
|
file_name | string |
Dateiname des Dokuments mit der Erweiterung. Dies ist hilfreich für die Konvertierung verschiedener Dateitypen. |
|
|
Datei-URL
|
file_url | string |
URL zur Dokumentdatei. Dokumente müssen für den Download verfügbar sein |
|
|
Automatisches Senden
|
is_automatic_sending | boolean |
Wenn das Dokument nach der Erstellung gesendet werden soll |
|
|
Erinnerungen senden
|
is_reminder_sending | boolean |
Sollte automatische Erinnerungen gesendet werden |
|
|
Planen des Sendens
|
is_scheduled_sending | boolean |
Sollte der Sendetermin für das Senden in Zukunft geplant sein |
|
|
Dokument signieren
|
is_signing | boolean |
Sollte das Dokument zum Signieren gesendet werden |
|
|
Handschriftliche Signatur
|
is_signing_biometric | boolean |
Handschriftliche Signatur verwenden |
|
|
Signaturübertragung zulassen
|
is_signing_forward | boolean |
Sollten Empfänger Signaturrechte übertragen können |
|
|
Signieren mit Initialen
|
is_signing_initials | boolean |
Signieren des Dokuments mithilfe von Empfängerinitialen |
|
|
SMS senden
|
is_sms_sending | boolean |
Sollte das Dokument per Text an den Empfänger gesendet werden |
|
|
Dokumentname
|
name | True | string |
Geben Sie einen Namen des Dokuments ein. |
|
Unternehmensname
|
company_name | string |
Firmenname des Empfängers |
|
|
Firmennummer
|
company_number | string |
Firmennummer des Empfängers |
|
|
Email
|
string |
E-Mail-Adresse des Empfängers |
||
|
Vorname
|
first_name | string |
Vorname des Empfängers |
|
|
Nachname
|
last_name | string |
Nachname des Empfängers |
|
|
Mobiltelefon
|
mobile | string |
Mobiltelefon im internationalen Format |
|
|
Hinweis
|
note | string |
Zusätzliche Notiz für einen Empfänger |
|
|
Signierreihenfolge
|
order_num | integer |
Wenn die Signierreihenfolge aktiviert ist |
|
|
Empfängertyp
|
role | string |
Die Art des Empfängers im Dokument |
|
|
Vorlagenrolle
|
role_name | string |
Der Name der Rolle in einer Vorlage |
|
|
Überprüfen von EID
|
verify_eid | boolean |
Überprüfen der Verwendung von EID |
|
|
EID-Typ
|
verify_eid_type | string |
EID-Typ, der für die persönliche Überprüfung verwendet werden soll |
|
|
Frage aktivieren
|
verify_qna | boolean |
Sollte eine Frage gestellt werden |
|
|
Bestätigungsantwort
|
verify_qna_answer | string |
Die Antwort auf Die Frage |
|
|
Frage zum Öffnen
|
verify_qna_open | boolean |
Sollte vor dem Öffnen des Dokuments Frage gestellt werden |
|
|
Überprüfungsfrage
|
verify_qna_question | string |
Frage zur Überprüfung |
|
|
Frage signieren
|
verify_qna_sign | boolean |
Sollte vor dem Signieren eine Frage gestellt werden |
|
|
SMS überprüfen
|
verify_sms | boolean |
Empfänger per SMS überprüfen |
|
|
Sms beim Öffnen überprüfen
|
verify_sms_open | boolean |
Sms beim Öffnen überprüfen |
|
|
Per SMS überprüfen
|
verify_sms_sign | boolean |
Sollte eine SMS den Empfänger vor dem Signieren überprüfen |
|
|
Sendetermin planen
|
scheduled_sending_time | date-time |
Datum und Uhrzeit, zu der das Dokument gesendet werden soll |
|
|
Außerkraftsetzung von Absender-E-Mails
|
sender_email | string |
Senden von anderen E-Mails als authentifizierten Benutzern |
|
|
Außerkraftsetzung des Absenderbenutzers
|
sender_id | string |
Senden von einem anderen Benutzer als authentifiziert |
|
|
Vorlagen-ID
|
template_id | string |
Wählen Sie eine Vorlage aus, die für das Senden verwendet werden soll. |
|
|
Dokumenttyp
|
type | string |
Festlegen des Typs/der Kategorie des Dokuments |
|
|
Dokumentwert
|
value | integer |
Wert des Deals oder Dokuments |
|
|
Video-ID
|
video_id | string |
Wählen Sie ein Video aus, das für das Senden verwendet werden soll. |
Gibt zurück
Ein Dokument ist eine oder mehrere hochgeladene Dateien, die an einen oder mehrere Empfänger gesendet werden sollen, die von einem Benutzer erstellt wurden.
- Dokument
- Document
Hochladen einer Anlage
Sie können Anlagendateien hochladen, um sie in von Ihnen gesendete Dokumente einzuschließen. Die erfolgreiche Anforderung gibt den attachment_id zurück. Verwenden Sie attachment_id, um einem Dokument eine Anlage zuzuweisen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dateiinhalt
|
file_content | string |
Senden Sie die Datei als base64-codiert. Beachten Sie, dass base64-Codierungsdateien die Dateigröße um ca. 30% |
|
|
Dateiname
|
file_name | string |
Dateiname des Dokuments mit der Erweiterung. Dies ist hilfreich für die Konvertierung verschiedener Dateitypen. |
|
|
Datei-URL
|
file_url | string |
URL zur Dokumentdatei. Die Datei muss ohne Autorisierung zum Download verfügbar sein. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Dateiname
|
filename | string |
Dateiname der Anlage |
|
Anlagen-ID
|
id | string |
ID der hochgeladenen Anlage, die beim Erstellen eines Dokuments in attachment_id verwendet werden soll |
|
Anlagentitel
|
title | string |
Titel der Anlage |
|
Anlagentyp
|
type | string |
Typ der Anlage |
Hochladen einer Dokumentdatei
Sie können jeweils eine Datei hochladen und eine Datei-ID abrufen. Die Datei-ID wird verwendet, um eine Datei mit einem GetAccept-Dokument zu verbinden, das an Empfänger gesendet wird. Wenn Sie mutliple Dateien hochladen möchten, führen Sie mehrere POST-Dateien aus. Wir akzeptieren dateien nur bis zu 10 MB als Standard. Hochgeladene Datei muss innerhalb von 48 Stunden nach dem Hochladen in ein Dokument importiert/hinzugefügt werden.
Wir empfehlen Ihnen, PDF-Dateien hochzuladen, um das gleiche Aussehen beim Senden zu gewährleisten. Andere Dateitypen können konvertiert werden, z. B.:
Mirosoft Office: doc, docx, xl, xls, xlsx, ppt, pptx Mac: numbers, key Images: jpg, jpeg, png Other: html, tex, csv
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dateiinhalt
|
file_content | string |
Senden Sie die Datei als base64-codiert. Beachten Sie, dass base64-Codierungsdateien die Dateigröße um ca. 30% |
|
|
Dateiname
|
file_name | string |
Dateiname des Dokuments mit der Erweiterung. Dies ist hilfreich für die Konvertierung verschiedener Dateitypen. |
|
|
Datei-URL
|
file_url | string |
URL zur Dokumentdatei. Die Datei muss ohne Autorisierung zum Download verfügbar sein. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Datei-ID
|
file_id | string |
ID der hochgeladenen Datei, die beim Erstellen eines Dokuments in file_ids verwendet werden soll |
|
file_status
|
file_status | string |
Status der hochgeladenen Datei |
Hochladen eines Videos
Sie können Anlagendateien hochladen, um sie in von Ihnen gesendete Dokumente einzuschließen. Die erfolgreiche Anforderung gibt den attachment_id zurück. Verwenden Sie attachment_id, um einem Dokument eine Anlage zuzuweisen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dateiinhalt
|
file_content | string |
Senden Sie die Datei als base64-codiert. Beachten Sie, dass base64-Codierungsdateien die Dateigröße um ca. 30% |
|
|
Dateiname
|
file_name | string |
Dateiname des Dokuments mit der Erweiterung. Dies ist hilfreich für die Konvertierung verschiedener Dateitypen. |
|
|
Datei-URL
|
file_url | string |
URL zur Dokumentdatei. Die Datei muss ohne Autorisierung zum Download verfügbar sein. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Dateistatus
|
file_status | string |
Status des Videos |
|
Dateiname
|
filename | string |
Dateiname des Videos |
|
Auftrags-ID
|
job_id | string |
ID des Verarbeitungsauftrags, der das Video konvertiert und komprimiert. Abrufen von Auftragsstatusaktualisierungen mithilfe von /video/job/<ID>. |
|
Video-ID
|
video_id | string |
ID des hochgeladenen Videos, das beim Erstellen eines Dokuments in video_id verwendet werden soll |
Kontakt erstellen
Dadurch wird ein neuer Kontakt in der Datenbank für die aktuelle Entität erstellt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name des Unternehmens
|
company_name | string |
Name des zugeordneten Unternehmens |
|
|
Firmennummer
|
company_number | string |
Zugeordnete Firmennummer |
|
|
Email
|
string |
E-Mail-Adresse des Kontakts |
||
|
Vorname
|
first_name | string |
Vorname des Kontakts |
|
|
Vollständiger Name
|
fullname | string |
Wird verwendet, um den vollständigen Namen anstelle des Vor-/Nachnamens anzugeben. |
|
|
Nachname
|
last_name | string |
Nachname des Kontakts |
|
|
Mobiltelefon
|
mobile | string |
Mobilnummer im internationalen Format |
|
|
Hinweis
|
note | string |
Optionale interne Notiz für Kontakt |
|
|
Telefonnummer
|
phone | string |
Telefonnummer im internationalen Format |
|
|
Title
|
title | string |
Der Titel des Kontakts, z. B. CEO, Vertriebsleiter |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Kontakt-ID
|
contact_id | string |
ID des erstellten Kontakts |
Kontakte auflisten
Empfangen einer Liste der verfügbaren Kontakte für die aktuelle Entität. Alle als Empfänger hinzugefügten Kontakte werden als Kontakt gespeichert und stehen für die spätere Verwendung in dieser Entität zur Verfügung.
Gibt zurück
Kontaktliste
- Kontakte
- Contacts
Listenvorlagen
Erhalten Sie eine Liste der verfügbaren Dokumentvorlagen. Sie können neue Vorlagen im Abschnitt "Vorlagen" in "GetAccept" hinzufügen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Alle anzeigen
|
showall | string |
Alle Vorlagen für die Entität anzeigen |
|
|
Ordner-ID
|
folder_id | string |
Anzeigen von Vorlagen in einem bestimmten Ordner |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
templates
|
templates | array of object | |
|
tags
|
templates.tags | string | |
|
erstellt_am
|
templates.created_at | string | |
|
external_editor_type
|
templates.external_editor_type | string | |
|
field_count
|
templates.field_count | integer | |
|
id
|
templates.id | string | |
|
is_editable
|
templates.is_editable | boolean | |
|
is_private
|
templates.is_private | boolean | |
|
name
|
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 | |
|
type
|
templates.type | string | |
|
user_id
|
templates.user_id | string | |
|
video_id
|
templates.video_id | string | |
|
video_thumb_url
|
templates.video_thumb_url | string |
Videos auflisten
Erhalten Sie eine Liste der verfügbaren Videos für die Entität. Sie können neue Videos in der mobilen App oder in GetAccept hinzufügen.
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
videos
|
videos | array of object | |
|
editierbar
|
videos.editable | boolean | |
|
veröffentlicht
|
videos.published | boolean | |
|
gespeichert
|
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 |
Vorhandenes Dokument senden
Wenn Sie ein Dokument über GetAccept senden, senden wir eine E-Mail an alle Empfänger, die jeweils einen eindeutigen, gesicherten Link enthalten. Dieser API-Aufruf löst die Aktion zum Senden von Dokumenten aus und kann nur für Dokumente mit document_status = Entwurf ausgeführt werden. Das Dokument wird an Empfänger gesendet, die Sie beim Erstellen angegeben haben.
Wenn ein Dokument mithilfe der Selbstsignieroption erstellt wurde, wird es auch vom authentifizierten oder angegebenen Benutzer vor dem Senden selbstsigniert.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
Dokument-ID |
|
sender_email
|
sender_email |
Verwenden Sie dies, um den Absenderbenutzer/Besitzer anhand der E-Mail-Adresse anzugeben, die zum Selbstsignieren des Dokuments verwendet werden soll. |
||
|
sender_id
|
sender_id | string |
Verwenden Sie diese Eigenschaft, um den Absenderbenutzer/Besitzer anhand der ID anzugeben, die zum Selbstsignieren des Dokuments verwendet werden soll. |
Gibt zurück
Ein Dokument ist eine oder mehrere hochgeladene Dateien, die an einen oder mehrere Empfänger gesendet werden sollen, die von einem Benutzer erstellt wurden.
- Dokument
- Document
Vorlagenfelder abrufen
Empfangen einer Liste von Feldern für eine bestimmte Vorlage.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vorlagen-ID
|
templateId | True | string |
Vorlagen-ID |
Gibt zurück
Feldliste
- Felder
- Fields
Vorlagenrollen abrufen
Empfangen einer Liste von Rollen für eine bestimmte Vorlage.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vorlagen-ID
|
templateId | True | string |
Vorlagen-ID |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
roles
|
roles | array of object | |
|
E-Mail
|
roles.email | string | |
|
first_name
|
roles.first_name | string | |
|
last_name
|
roles.last_name | string | |
|
mobile
|
roles.mobile | string | |
|
role
|
roles.role | string | |
|
role_id
|
roles.role_id | string | |
|
role_name
|
roles.role_name | string |
Auslöser
| Abonnieren von Dokumentereignissen |
Dieser Anruf erstellt ein neues Abonnement. Die Antwort wird in ein Array eingeschlossen, auch für einzelne Objekte gemäß REST-Hook-Standards.
|
| Wenn ein Dokument abgelehnt wurde |
Löst aus, wenn ein Dokument von einem der Empfänger abgelehnt wurde |
| Wenn ein Dokument signiert wurde |
Löst aus, wenn ein Dokument von allen Signaturparteien signiert wurde |
| Wenn ein Dokument überprüft wurde |
Löst aus, wenn ein Dokument von einem der Empfänger überprüft wurde. |
Abonnieren von Dokumentereignissen
Dieser Anruf erstellt ein neues Abonnement. Die Antwort wird in ein Array eingeschlossen, auch für einzelne Objekte gemäß REST-Hook-Standards.
Ereignisse
-
document.created- Dokument wird erstellt -
document.sent- Dokument wird gesendet -
document.viewed- Dokument wird gesendet -
document.signed- Dokument ist signiert -
document.approved- Dokument wurde genehmigt -
document.expired- Dokument ist abgelaufen -
document.rejected- Dokument wird abgelehnt -
document.downloaded- Dokument wird heruntergeladen -
document.printed- Dokument wird gedruckt -
document.forwarded- Dokument wird weitergeleitet -
document.partially_signed- Dokument wurde teilweise signiert -
document.commented- Das Dokument ist kommentiert. -
document.hardbounced- Dokument ist hartbounced -
document.imported- Dokument wird importiert
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ereignis auswählen
|
event | True | string |
Ereignistrigger |
|
Alle Entitätsbenutzer
|
global | boolean |
Wenn der Webhook Ereignisse für alle Entitätsbenutzer erfassen soll. |
|
|
Fehler-E-Mail
|
notification_email | string |
Wenn das Ereignis fehlschlägt, senden Sie eine Benachrichtigung an diese E-Mail anstelle des Absenders. |
|
|
Nutzlast
|
payload | string |
Zusätzliche Nutzlastdaten zum Posten |
Gibt zurück
Webhook-Nutzlast
- Webhook
- Webhook
Wenn ein Dokument abgelehnt wurde
Löst aus, wenn ein Dokument von einem der Empfänger abgelehnt wurde
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Alle Entitätsbenutzer
|
global | boolean |
Wenn der Webhook Ereignisse für alle Entitätsbenutzer erfassen soll. |
|
|
Fehler-E-Mail
|
notification_email | string |
Wenn das Ereignis fehlschlägt, senden Sie eine Benachrichtigung an diese E-Mail anstelle des Absenders. |
|
|
Nutzlast
|
payload | string |
Zusätzliche Nutzlastdaten zum Posten |
Gibt zurück
Webhook-Nutzlast
- Webhook
- Webhook
Wenn ein Dokument signiert wurde
Löst aus, wenn ein Dokument von allen Signaturparteien signiert wurde
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Alle Entitätsbenutzer
|
global | boolean |
Wenn der Webhook Ereignisse für alle Entitätsbenutzer erfassen soll. |
|
|
Fehler-E-Mail
|
notification_email | string |
Wenn das Ereignis fehlschlägt, senden Sie eine Benachrichtigung an diese E-Mail anstelle des Absenders. |
|
|
Nutzlast
|
payload | string |
Zusätzliche Nutzlastdaten zum Posten |
Gibt zurück
Webhook-Nutzlast
- Webhook
- Webhook
Wenn ein Dokument überprüft wurde
Löst aus, wenn ein Dokument von einem der Empfänger überprüft wurde.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Alle Entitätsbenutzer
|
global | boolean |
Wenn der Webhook Ereignisse für alle Entitätsbenutzer erfassen soll. |
|
|
Fehler-E-Mail
|
notification_email | string |
Wenn das Ereignis fehlschlägt, senden Sie eine Benachrichtigung an diese E-Mail anstelle des Absenders. |
|
|
Nutzlast
|
payload | string |
Zusätzliche Nutzlastdaten zum Posten |
Gibt zurück
Webhook-Nutzlast
- Webhook
- Webhook
Definitionen
Anhang
Dokumentanlage
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zugreifen auf Empfänger
|
access_recipient_names | array of string |
Empfänger mit Zugriff auf die Anlage |
|
Description
|
attachment_description | string |
Beschreibung der Anlage |
|
URL herunterladen
|
attachment_download_url | string |
URL zum Herunterladen der Anlage |
|
Dateinamenerweiterung
|
attachment_extension | string |
Dateierweiterung der Anlage |
|
Dateiname
|
attachment_filename | string |
Dateiname der Anlage |
|
ID
|
attachment_id | string |
ID der Anlage |
|
Vorschau-URL
|
attachment_preview_url | string |
Interne URL zum Anzeigen einer Vorschau der Anlage |
|
Title
|
attachment_title | string |
Titel der Anlage |
|
Typ
|
attachment_type | string |
Typ der Anlage |
|
URL
|
attachment_url | string |
URL der Anlage |
|
Letzte Ansicht
|
last_attachment_view | string |
Datum und Uhrzeit der letzten Anzeige der Anlage |
|
Eingeschränkter Zugriff
|
restrict_access | boolean |
Anlage hat eingeschränkten Zugriff |
Attachments
Anlagenliste
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
attachments
|
attachments | array of Attachment |
Kontakt
Jede eindeutige E-Mail-Adresse (oder Mobiltelefonnummer) wird als Kontakt definiert.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Unternehmens-ID
|
company_id | string |
Unternehmens-ID |
|
Firmenlogo
|
company_logo_url | string |
Firmenlogo |
|
Unternehmensname
|
company_name | string |
Firmenname des Kontakts |
|
Firmennummer
|
company_number | string |
Firmennummer des Kontakts |
|
Kontakt-ID
|
contact_id | string |
Kontakt-ID |
|
Erstellt
|
created_at | string |
Erstellungsdatum des Kontakts |
|
Dokumente
|
document_count | number |
Anzahl der Dokumente für einen Kontakt |
|
Kontakt-E-Mail
|
string |
Name des erstellten Dokuments |
|
|
Vorname
|
first_name | string |
Vorname des Kontakts |
|
Vollständiger Name
|
fullname | string |
Vollständiger Name des Kontakts |
|
Geschlecht
|
gender | string |
Geschlecht des Empfängers |
|
Nachname
|
last_name | string |
Nachname des Kontakts |
|
Mobiltelefon
|
mobile | string |
Mobiltelefonnummer des Kontakts |
|
Hinweis
|
note | string |
Hinweis des Kontakts |
|
Daumen-URL
|
thumb_url | string |
Daumen-URL des Kontakts |
|
Title
|
title | string |
Titel des Kontakts |
Kontakte
Kontaktliste
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
contacts
|
contacts | array of Contact |
Dokument
Ein Dokument ist eine oder mehrere hochgeladene Dateien, die an einen oder mehrere Empfänger gesendet werden sollen, die von einem Benutzer erstellt wurden.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Stichwörter
|
tags | string |
Dokumenttags |
|
Automatischer Chattext
|
auto_comment_text | string |
Automatischer Chattext |
|
Name des Unternehmens
|
company_name | string |
Name des Unternehmens |
|
Erstellt am
|
created_at | string |
Wann das Dokument erstellt wurde |
|
URL herunterladen
|
download_url | string |
URL zum Herunterladen eines signierten Dokuments |
|
E-Mail-Nachricht
|
email_send_message | string |
Senden einer E-Mail-Nachricht |
|
E-Mail-Betreff
|
email_send_subject | string |
E-Mail-Betrefftext |
|
Ablaufdatum
|
expiration_date | string |
Ablaufdatum des Dokuments |
|
Externe Client-ID
|
external_client_id | string | |
|
Id des externen Editors
|
external_editor_id | string |
ID im externen Editor |
|
Externer Editortyp
|
external_editor_type | string | |
|
Externe ID
|
external_id | string | |
|
Feldanzahl
|
field_count | integer |
Anzahl der Felder im Dokument |
|
ID
|
id | string | |
|
Automatischer Kommentar
|
is_auto_comment | boolean |
Wenn der Kommentar für den automatischen Chat aktiviert ist |
|
Automatische Kommentar-E-Mail
|
is_auto_comment_email | boolean |
Wenn die automatische Chat-E-Mail aktiviert ist |
|
Empfänger identifizieren
|
is_identify_recipient | boolean |
Wenn das Dokument den Empfänger identifiziert hat |
|
Ist privat
|
is_private | boolean |
Wenn das Dokument privat ist |
|
Erinnerungen senden
|
is_reminder_sending | boolean |
Wenn automatische Erinnerungen aktiviert sind |
|
Geplantes Senden
|
is_scheduled_sending | boolean |
Wenn das Dokument das Senden geplant hat |
|
Selbstsignieren
|
is_selfsign | boolean |
Wenn das Dokument vom Absender selbst signiert wurde |
|
Ist signiert
|
is_signed | boolean |
Wenn das Dokument signiert wurde |
|
Signierbares Dokument
|
is_signing | boolean |
Wenn das Dokument signierbar ist |
|
Handschriftliche Signatur
|
is_signing_biometric | boolean |
Wenn handschriftliche Signatur aktiviert ist |
|
Signaturübertragung zulassen
|
is_signing_forward | boolean |
Wenn die Übertragung von Signaturrechten aktiviert ist |
|
Signaturreihenfolge
|
is_signing_order | boolean |
Wenn die Reihenfolge der Empfängersignatur aktiviert ist |
|
Hat Video
|
is_video | boolean |
Wenn das Dokument über ein Einführungsvideo verfügt |
|
Name
|
name | string |
Name des Dokuments |
|
Übergeordnete ID
|
parent_id | string |
ID der vorherigen Dokumentversion |
|
Vorschau-URL
|
preview_url | string |
Link zur internen Vorschau des Dokuments |
|
recipients
|
recipients | array of Recipient | |
|
Geplante Sendezeit
|
scheduled_sending_time | string |
Wann das Dokument für das Senden geplant wurde |
|
Sendedatum
|
send_date | string |
Sendedatum des Dokuments |
|
Absender-E-Mail
|
sender_email | string |
E-Mail-Adresse des Absenderbenutzers |
|
Absendername
|
sender_name | string |
Name des Absenderbenutzers |
|
Absenderfinger-URL
|
sender_thumb_url | string |
Miniaturbild des Absenderbenutzers |
|
Signierdatum
|
sign_date | string |
Dokumentzeichendatum |
|
Der Status
|
status | string |
Aktueller Status des Dokuments |
|
Daumen-URL
|
thumb_url | string |
Miniaturbild des Dokuments |
|
Typ
|
type | string |
Dokumenttyp |
|
Eindeutige ID
|
unique_id | integer |
Eindeutige ID für Das Dokument |
|
Benutzer-ID
|
user_id | string |
ID des Absenderbenutzers |
|
Wert
|
value | integer |
Wert des Dokuments |
Dokumente
Dokumentliste
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
tags
|
tags | string | |
|
company_name
|
company_name | string | |
|
erstellt_am
|
created_at | string | |
|
expiration_date
|
expiration_date | string | |
|
id
|
id | string | |
|
is_private
|
is_private | boolean | |
|
is_signing
|
is_signing | boolean | |
|
name
|
name | string | |
|
sender_name
|
sender_name | string | |
|
sender_thumb
|
sender_thumb | string | |
|
status
|
status | string | |
|
type
|
type | string | |
|
value
|
value | integer |
EditorField
Editor-Felddetails
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
ID |
|
Etikett
|
input_settings.label | string |
Etikett |
|
Options
|
input_settings.options | array of string |
Options |
|
Erforderlich
|
input_settings.required | boolean |
Erforderlich |
|
Typ
|
input_settings.type | string |
Typ |
|
Empfänger-ID
|
recipient_id | string |
Empfänger-ID |
|
Typ
|
type | string |
Typ |
|
Benutzer-ID
|
user_id | string |
Benutzer-ID |
Feld
Felddetails
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Name des Unternehmens
|
company_name | string |
Name des Unternehmens |
|
Firmennummer
|
company_number | string |
Firmennummer |
|
Feld-ID
|
field_id | string |
Feld-ID |
|
Etikett
|
field_label | string |
Etikett |
|
Options
|
field_options | array of object |
Options |
|
Wert
|
field_options.value | string | |
|
Typ
|
field_type | string |
Typ |
|
Wert
|
field_value | string |
Wert |
|
is_collectable
|
is_collectable | boolean |
Sammeln von Feldern |
|
is_editable
|
is_editable | boolean |
Bearbeitbares Feld |
|
is_required
|
is_required | boolean |
Pflichtfeld |
|
Seiten-ID
|
page_id | string |
Seiten-ID |
|
Empfänger-ID
|
recipient_id | string |
Empfänger-ID |
|
Empfängername
|
recipient_name | string |
Empfängername |
|
Rollenname
|
role_name | string |
Rollenname |
Felder
Feldliste
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
editor_fields
|
editor_fields | array of EditorField | |
|
fields
|
fields | array of Field |
PricingColumn
Preistabellenspalte
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
column_id | string |
ID |
|
Anzeigename
|
display_name | string |
Anzeigename |
|
Enabled
|
enabled | boolean |
Enabled |
|
Name
|
name | string |
Name |
PricingSection
Abschnitt "Preistabelle"
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
columns
|
columns | array of PricingColumn | |
|
Anzeigename
|
display_name | string |
Anzeigename |
|
Name
|
name | string |
Name |
|
ID
|
section_id | string |
ID |
PricingTable
Preistabelle
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Währung
|
currency_settings.currency | string |
Währung |
|
Gebietsschema
|
currency_settings.locale | string |
Gebietsschema |
|
Vorab berechnete Summen
|
pre_calculated | boolean |
Vorab berechnete Summen |
|
Abschnitte
|
sections | array of PricingSection | |
|
ID
|
table_id | string |
Tabellenkennung (ID) |
PricingTables
Preistabellen
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
pricing_tables
|
pricing_tables | array of PricingTable |
Recipient
Jede eindeutige E-Mail-Adresse (oder Mobiltelefonnummer), die mit einem Dokument verbunden ist, ist ein Empfänger.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Unternehmensname
|
company_name | string |
Firmenname des Empfängers |
|
Firmennummer
|
company_number | string |
Firmennummer des Empfängers |
|
Dokument-URL
|
document_url | string |
Eindeutige URL für den Empfänger zum Anzeigen/Signieren |
|
E-Mail-Adresse des Empfängers
|
string |
E-Mail des Empfängers |
|
|
Vorname
|
first_name | string |
Vorname des Empfängers |
|
Vollständiger Name
|
fullname | string |
Vollständiger Name des Empfängers |
|
Geschlecht
|
gender | string |
Geschlecht des Empfängers |
|
ID
|
id | string |
ID des Empfängers |
|
Nachname
|
last_name | string |
Nachname des Empfängers |
|
Mobiltelefon
|
mobile | string |
Mobiltelefonnummer des Empfängers |
|
Hinweis
|
note | string |
Hinweis des Empfängers |
|
Zahl der Signierreihenfolge
|
order_num | string |
Signierreihenfolge des Empfängers |
|
Der Status
|
status | string |
Status des Empfängers |
|
Daumen-URL
|
thumb_url | string |
Daumen-URL des Empfängers |
|
Title
|
title | string |
Titel des Empfängers |
Empfänger
Empfängerliste
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
recipients
|
recipients | array of Recipient |
Benutzer
Ein Benutzer wird durch die E-Mail-Adresse definiert und ist mit einer oder mehreren Entitäten verbunden.
Benutzerrollen
Administrator:
- Alle Dokumente anzeigen
- Alle Dokumente bearbeiten
- Ändern von Entitätseinstellungen, Informationen und Abrechnungen
- Hinzufügen neuer Benutzer zur Entität
- Zuweisen von Entitätsrollen
Manager:
- Anzeigen von Teamdokumenten
- Alle Dokumente bearbeiten
- Hinzufügen neuer Benutzer zur Entität
Entität
Eine Entität ist der oberste Knoten, und alle Benutzer und die entsprechenden Dokumente sind mit einer Entität verbunden. Eine Entität ist häufig mit einem Unternehmen, einem Land oder einer Abteilung in einer großen Organisation identisch.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
App-Modus
|
app_mode | string | |
|
disallow_create
|
disallow_create | boolean | |
|
Email
|
string |
E-Mail-Adresse des Benutzers |
|
|
Entitäts-ID
|
entity_id | string | |
|
Entitätsname
|
entity_name | string | |
|
Vorname
|
first_name | string |
Vorname des Benutzers |
|
ID
|
id | string |
ID des Benutzers |
|
Language
|
language | string | |
|
Nachname
|
last_name | string |
Nachname des Benutzers |
|
mobile
|
mobile | string |
Mobilnummer im internationalen Format |
|
Hinweis
|
note | string |
Optionale interne Notiz für Benutzer |
|
Telefonnummer
|
phone | string |
Telefonnummer im internationalen Format |
|
Rolle
|
role | string | |
|
Senden der Einladung überspringen
|
skip_invitation | boolean | |
|
Der Status
|
status | string | |
|
Team-ID
|
team_id | string | |
|
Daumen-URL
|
thumb_url | string | |
|
Timezone
|
timezone | string | |
|
Title
|
title | string |
Der Titel des Benutzers, z. B. CEO, Vertriebsleiter |
Benutzer
Benutzerliste
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Nutzer
|
users | array of object | |
|
Email
|
users.email | string | |
|
Vorname
|
users.first_name | string | |
|
Letzte Anmeldung
|
users.last_login | string | |
|
Nachname
|
users.last_name | string | |
|
Benutzername
|
users.name | string | |
|
Rolle
|
users.role | string | |
|
Der Status
|
users.status | string | |
|
Teamname
|
users.team_name | string | |
|
Benutzer-ID
|
users.user_id | string |
Webhook
Webhook-Nutzlast
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Benutzerdefinierte Felder
|
custom_fields | object | |
|
Dokument
|
document | Document |
Ein Dokument ist eine oder mehrere hochgeladene Dateien, die an einen oder mehrere Empfänger gesendet werden sollen, die von einem Benutzer erstellt wurden. |
|
Benutzerdefinierte Entitätsdomäne
|
entity.custom_domain | string |
Benutzerdefinierte Domäneneinstellung für entität |
|
Standard-E-Mail-Nachricht
|
entity.email_send_message | string |
Standard-E-Mail-Nachricht |
|
Standard-E-Mail-Betreff
|
entity.email_send_subject | string |
Standard-E-Mail-Betreff |
|
Entitätsunterdomäne
|
entity.sub_domain | string |
Unterdomäne für die Entität |
|
Ereignisname
|
event | string | |
|
Ereignisaktion
|
event_action | string | |
|
Ereignistyp
|
event_type | string | |
|
Recipient
|
recipient | Recipient |
Jede eindeutige E-Mail-Adresse (oder Mobiltelefonnummer), die mit einem Dokument verbunden ist, ist ein Empfänger. |
|
Abonnement-ID
|
subscription_id | string |