GetAccept
GetAccept zapewnia platformę włączania sprzedaży do projektowania, wysyłania, promowania, śledzenia i podpisywania dokumentów sprzedaży, wykorzystania zabezpieczeń sprzedaży, zarządzania umowami, propozycji i podpisów elektronicznych w jednym miejscu.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | GetAccept API Team |
| adres URL | https://app.getaccept.com/api |
| integrations@getaccept.com |
| Metadane łącznika | |
|---|---|
| Publisher | GetAccept, Inc. |
| Witryna internetowa | https://www.getaccept.com |
| Zasady ochrony prywatności | https://www.getaccept.com/privacy-policy |
| Kategorie | Sprzedaż i CRM; Produktywność |
GetAccept zapewnia platformę włączania sprzedaży do projektowania, wysyłania, promowania, śledzenia i podpisywania dokumentów sprzedaży, wykorzystania zabezpieczeń sprzedaży, zarządzania umowami, propozycji i podpisów elektronicznych w jednym miejscu. Ten łącznik pomaga zautomatyzować przepływy pracy dla magazynu dokumentów, pobierania, przypisywania zadań i dostosowanych powiadomień.
Wymagania wstępne
Do korzystania z tego połączenia jest wymagane konto GetAccept. Przejdź do getaccept.com , aby zarejestrować bezpłatne konto.
Jak uzyskać poświadczenia?
Wymagane jest tylko prawidłowe konto GetAccept, ponieważ uwierzytelnianie OAuth2 jest używane do uwierzytelniania bieżącego zalogowanego użytkownika w aplikacji GetAccept.
Znane problemy i ograniczenia
Skontaktuj się z nami [mailto:support@getaccept.com](pomoc techniczna) w celu uzyskania wszelkich problemów związanych z integracją.
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie wygaśnięcia dokumentu |
Użyj tej metody, aby zaktualizować datę i godzinę wygaśnięcia dokumentu. |
| Pobieranie adresatów dokumentów |
Pobierz listę adresatów dla określonego dokumentu. |
| Pobieranie dokumentu |
Plik dokumentu można zawsze pobrać, ale najprawdopodobniej chcesz go pobrać, gdy ma stan Podpisany. Możesz wybrać, aby otrzymać adres URL pobierania lub pobrać plik binarny. Adres URL pobierania można uzyskać dostęp do 10 minut po wykonaniu żądania. |
| Pobieranie pól dokumentu |
Pobierz listę pól dla dokumentu lub szablonu. Można użyć zarówno przed, jak i po podpisaniu dokumentu. |
| Pobieranie pól szablonu |
Odbieranie listy pól dla określonego szablonu. |
| Pobieranie ról szablonu |
Odbieranie listy ról dla określonego szablonu. |
| Pobieranie szczegółów dokumentu |
Pobierz szczegóły dokumentu, określając identyfikator dokumentu. |
| Pobieranie szczegółów użytkownika |
To wywołanie zwróci szczegóły pojedynczego użytkownika. Odbieranie szczegółów i dostępnych jednostek bieżącego uwierzytelnionego użytkownika przy użyciu identyfikatora użytkownika |
| Pobieranie tabel cen szablonu |
Uzyskaj listę elementów tabeli cen dla określonego szablonu. |
| Pobieranie załączników dokumentów |
Pobierz załączniki dokumentów, określając identyfikator dokumentu. |
| Przekazywanie pliku dokumentu |
Jednocześnie można przekazać jeden plik i uzyskać identyfikator pliku. Identyfikator pliku służy do łączenia pliku z dokumentem GetAccept, który jest wysyłany do adresatów. Jeśli chcesz przekazać pliki mutliple, uruchamiasz wiele plików POST. Akceptujemy tylko pliki do 10 MB jako domyślne. Przekazany plik musi zostać zaimportowany/dodany do dokumentu w ciągu 48 godzin po przekazaniu. Zalecamy przekazanie plików PDF w celu zagwarantowania tego samego wyglądu po wysłaniu. Inne typy plików można przekonwertować, na przykład: Mirosoft Office: doc, docx, xls, xlsx, pptx Mac: numbers, key Images: jpg, jpeg, png Other: html, tex, csv |
| Przekazywanie wideo |
Możesz przekazać pliki załączników, aby dołączyć je do wysyłanych dokumentów. Pomyślne żądanie zwróci attachment_id. Użyj attachment_id, aby przypisać załącznik do dokumentu. |
| Przekazywanie załącznika |
Możesz przekazać pliki załączników, aby dołączyć je do wysyłanych dokumentów. Pomyślne żądanie zwróci attachment_id. Użyj attachment_id, aby przypisać załącznik do dokumentu. |
| Szablony list |
Otrzymuj listę dostępnych szablonów dokumentów. Nowe szablony można dodać w sekcji Szablony w sekcji GetAccept. |
| Tworzenie i wysyłanie dokumentu lub szablonu |
Musisz utworzyć dokument, aby móc wysłać go do adresata. Podczas tworzenia dokumentu można odwołać się do wcześniej przekazanych plików za pomocą file_id lub wybrać utworzenie dokumentu i przekazanie plików we wpisie interfejsu API. Można przekazać tylko jeden plik w przypadku dołączania pliku w dokumencie tworzenia POST. Użyj parametru file_ids, aby użyć istniejących przekazanych plików, file_content wysłać dokument jako ciąg zakodowany w formacie base64 lub wykonać wpis wieloczęściowy z parametrem pliku. Wszyscy adresaci muszą mieć prawidłowy adres e-mail lub numer telefonu komórkowego. Wszystkie zdarzenia są rejestrowane przy użyciu adresu IP osoby żądającej. Można to zastąpić przy użyciu nagłówka CLIENT_IP zawierającego publiczny adres IP użytkowników końcowych. |
| Utwórz kontakt |
Spowoduje to utworzenie nowego kontaktu w bazie danych dla bieżącej jednostki |
| Utwórz użytkownika |
Spowoduje to utworzenie nowego kontaktu w bazie danych dla bieżącej jednostki |
| Wysyłanie istniejącego dokumentu |
Po wysłaniu dokumentu za pośrednictwem polecenia GetAccept dostarczamy wiadomość e-mail do wszystkich adresatów, z których każdy zawiera unikatowy, zabezpieczony link. To wywołanie interfejsu API wyzwala akcję wysyłania dokumentu i może być wykonywane tylko na dokumentach z document_status = wersja robocza. Dokument zostanie wysłany do adresatów podanych podczas jego tworzenia. Jeśli dokument został utworzony przy użyciu opcji samodzielnego podpisywania, zostanie również podpisany samodzielnie przez uwierzytelnionego lub określonego użytkownika przed wysłaniem. |
| Wyświetlanie listy dokumentów |
Pobieranie listy dostępnych dokumentów |
| Wyświetlanie listy filmów wideo |
Odbieranie listy dostępnych filmów wideo w jednostce. Możesz dodać nowe filmy wideo w aplikacji mobilnej lub wewnątrz aplikacji GetAccept. |
| Wyświetlanie listy kontaktów |
Odbierz listę dostępnych kontaktów dla bieżącej jednostki. Wszystkie kontakty dodane jako adresat są zapisywane jako kontakt i są dostępne do późniejszego użycia w tej jednostce. |
| Wyświetlanie listy użytkowników |
Pobieranie listy aktywnych użytkowników dla bieżącej uwierzytelnionej jednostki |
| Wyświetlanie listy załączników |
Otrzymuj listę dostępnych załączników. Nowe załączniki można dodać w programie GetAccept przy użyciu nowego dokumentu. |
Aktualizowanie wygaśnięcia dokumentu
Użyj tej metody, aby zaktualizować datę i godzinę wygaśnięcia dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Identyfikator dokumentu |
|
Data wygaśnięcia
|
expiration_date | date-time |
Data i godzina wygaśnięcia dokumentu (UTC) |
|
|
Wysyłanie powiadomienia
|
send_notification | boolean |
W przypadku wysłania powiadomienia o aktualizacji do adresatów |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Status
|
status | integer |
Stan aktualizacji |
Pobieranie adresatów dokumentów
Pobierz listę adresatów dla określonego dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Identyfikator dokumentu |
Zwraca
Lista adresatów
- Adresatów
- Recipients
Pobieranie dokumentu
Plik dokumentu można zawsze pobrać, ale najprawdopodobniej chcesz go pobrać, gdy ma stan Podpisany.
Możesz wybrać, aby otrzymać adres URL pobierania lub pobrać plik binarny.
Adres URL pobierania można uzyskać dostęp do 10 minut po wykonaniu żądania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Identyfikator dokumentu |
|
Zwracanie pliku binarnego bezpośrednio
|
direct | string |
Zwracanie pliku binarnego bezpośrednio |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
document_url
|
document_url | string | |
|
plik
|
file | string |
Pobieranie pól dokumentu
Pobierz listę pól dla dokumentu lub szablonu. Można użyć zarówno przed, jak i po podpisaniu dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Identyfikator dokumentu |
Zwraca
Lista pól
- Pola formularza
- Fields
Pobieranie pól szablonu
Odbieranie listy pól dla określonego szablonu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator szablonu
|
templateId | True | string |
Identyfikator szablonu |
Zwraca
Lista pól
- Pola formularza
- Fields
Pobieranie ról szablonu
Odbieranie listy ról dla określonego szablonu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator szablonu
|
templateId | True | string |
Identyfikator szablonu |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
roles
|
roles | array of object | |
|
e-mail
|
roles.email | string | |
|
first_name
|
roles.first_name | string | |
|
last_name
|
roles.last_name | string | |
|
mobilne
|
roles.mobile | string | |
|
rola
|
roles.role | string | |
|
role_id
|
roles.role_id | string | |
|
role_name
|
roles.role_name | string |
Pobieranie szczegółów dokumentu
Pobierz szczegóły dokumentu, określając identyfikator dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Identyfikator dokumentu |
Zwraca
Dokument to jeden lub wiele przekazanych plików, które mają być wysyłane do jednego lub wielu adresatów utworzonych przez użytkownika.
- Dokument
- Document
Pobieranie szczegółów użytkownika
To wywołanie zwróci szczegóły pojedynczego użytkownika. Odbieranie szczegółów i dostępnych jednostek bieżącego uwierzytelnionego użytkownika przy użyciu identyfikatora użytkownika
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator użytkownika
|
userId | True | string |
Identyfikator użytkownika |
Zwraca
Użytkownik jest definiowany przez jego adres e-mail i jest połączony z jedną lub wieloma jednostkami.
Role użytkowników
Administrator:
- Wyświetlanie wszystkich dokumentów
- Edytuj wszystkie dokumenty
- Zmienianie ustawień jednostki, informacji i rozliczeń
- Dodawanie nowych użytkowników do jednostki
- Przypisywanie ról jednostek
Menedżer:
- Wyświetlanie dokumentów zespołu
- Edytuj wszystkie dokumenty
- Dodawanie nowych użytkowników do jednostki
Encja
Jednostka jest głównym węzłem, a wszyscy użytkownicy i odpowiednie dokumenty są połączone z jednostką. Jednostka jest często taka sama jak firma, kraj lub dział w dużej organizacji.
- User
- User
Pobieranie tabel cen szablonu
Uzyskaj listę elementów tabeli cen dla określonego szablonu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator szablonu
|
templateId | True | string |
Identyfikator szablonu |
Zwraca
Tabele cen
- Pricing
- PricingTables
Pobieranie załączników dokumentów
Pobierz załączniki dokumentów, określając identyfikator dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Identyfikator dokumentu |
Zwraca
Lista załączników
- Załączniki
- Attachments
Przekazywanie pliku dokumentu
Jednocześnie można przekazać jeden plik i uzyskać identyfikator pliku. Identyfikator pliku służy do łączenia pliku z dokumentem GetAccept, który jest wysyłany do adresatów. Jeśli chcesz przekazać pliki mutliple, uruchamiasz wiele plików POST. Akceptujemy tylko pliki do 10 MB jako domyślne. Przekazany plik musi zostać zaimportowany/dodany do dokumentu w ciągu 48 godzin po przekazaniu.
Zalecamy przekazanie plików PDF w celu zagwarantowania tego samego wyglądu po wysłaniu. Inne typy plików można przekonwertować, na przykład:
Mirosoft Office: doc, docx, xls, xlsx, pptx Mac: numbers, key Images: jpg, jpeg, png Other: html, tex, csv
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Zawartość pliku
|
file_content | string |
Wyślij plik jako zakodowany w formacie base64. Należy pamiętać, że pliki kodowania base64 zwiększą rozmiar pliku z około 30% |
|
|
Nazwa pliku
|
file_name | string |
Nazwa pliku dokumentu z rozszerzeniem . Będzie to przydatne w przypadku konwertowania różnych typów plików. |
|
|
Adres URL pliku
|
file_url | string |
Adres URL do pliku dokumentu. Plik musi być dostępny do pobrania bez autoryzacji |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator_pliku
|
file_id | string |
Identyfikator przekazanego pliku do użycia w file_ids podczas tworzenia dokumentu |
|
file_status
|
file_status | string |
Stan przekazanego pliku |
Przekazywanie wideo
Możesz przekazać pliki załączników, aby dołączyć je do wysyłanych dokumentów. Pomyślne żądanie zwróci attachment_id. Użyj attachment_id, aby przypisać załącznik do dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Zawartość pliku
|
file_content | string |
Wyślij plik jako zakodowany w formacie base64. Należy pamiętać, że pliki kodowania base64 zwiększą rozmiar pliku z około 30% |
|
|
Nazwa pliku
|
file_name | string |
Nazwa pliku dokumentu z rozszerzeniem . Będzie to przydatne w przypadku konwertowania różnych typów plików. |
|
|
Adres URL pliku
|
file_url | string |
Adres URL do pliku dokumentu. Plik musi być dostępny do pobrania bez autoryzacji |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Stan pliku
|
file_status | string |
Stan filmu wideo |
|
Nazwa pliku
|
filename | string |
Nazwa pliku wideo |
|
Identyfikator zadania
|
job_id | string |
Identyfikator zadania przetwarzania konwertujące i kompresujące wideo. Sonduj aktualizacje stanu zadania przy użyciu /video/job/<ID>. |
|
Identyfikator wideo
|
video_id | string |
Identyfikator przekazanego klipu wideo do użycia w video_id podczas tworzenia dokumentu |
Przekazywanie załącznika
Możesz przekazać pliki załączników, aby dołączyć je do wysyłanych dokumentów. Pomyślne żądanie zwróci attachment_id. Użyj attachment_id, aby przypisać załącznik do dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Zawartość pliku
|
file_content | string |
Wyślij plik jako zakodowany w formacie base64. Należy pamiętać, że pliki kodowania base64 zwiększą rozmiar pliku z około 30% |
|
|
Nazwa pliku
|
file_name | string |
Nazwa pliku dokumentu z rozszerzeniem . Będzie to przydatne w przypadku konwertowania różnych typów plików. |
|
|
Adres URL pliku
|
file_url | string |
Adres URL do pliku dokumentu. Plik musi być dostępny do pobrania bez autoryzacji |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Nazwa pliku
|
filename | string |
Nazwa pliku załącznika |
|
Identyfikator załącznika
|
id | string |
Identyfikator przekazanego załącznika do użycia w attachment_id podczas tworzenia dokumentu |
|
Tytuł załącznika
|
title | string |
Tytuł załącznika |
|
Typ załącznika
|
type | string |
Typ załącznika |
Szablony list
Otrzymuj listę dostępnych szablonów dokumentów. Nowe szablony można dodać w sekcji Szablony w sekcji GetAccept.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Pokaż wszystko
|
showall | string |
Pokaż wszystkie szablony dla jednostki |
|
|
Identyfikator folderu
|
folder_id | string |
Pokaż szablony w określonym folderze |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
templates
|
templates | array of object | |
|
tags
|
templates.tags | string | |
|
utworzono_o
|
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 | |
|
nazwa
|
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 | |
|
typ
|
templates.type | string | |
|
user_id
|
templates.user_id | string | |
|
video_id
|
templates.video_id | string | |
|
video_thumb_url
|
templates.video_thumb_url | string |
Tworzenie i wysyłanie dokumentu lub szablonu
Musisz utworzyć dokument, aby móc wysłać go do adresata. Podczas tworzenia dokumentu można odwołać się do wcześniej przekazanych plików za pomocą file_id lub wybrać utworzenie dokumentu i przekazanie plików we wpisie interfejsu API. Można przekazać tylko jeden plik w przypadku dołączania pliku w dokumencie tworzenia POST.
Użyj parametru file_ids, aby użyć istniejących przekazanych plików, file_content wysłać dokument jako ciąg zakodowany w formacie base64 lub wykonać wpis wieloczęściowy z parametrem pliku.
Wszyscy adresaci muszą mieć prawidłowy adres e-mail lub numer telefonu komórkowego.
Wszystkie zdarzenia są rejestrowane przy użyciu adresu IP osoby żądającej. Można to zastąpić przy użyciu nagłówka CLIENT_IP zawierającego publiczny adres IP użytkowników końcowych.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator załącznika odebrany z listy lub po przekazaniu |
|
|
Wymagaj widoku
|
require_view | boolean |
Wymagaj, aby adresat wyświetlał załącznik |
|
|
Typ
|
type | string |
plik lub zewnętrzny, gdzie plik jest przekazanym plikiem, a zewnętrzne jest linkiem do pliku zewnętrznego |
|
|
Identyfikator pola
|
id | string |
Identyfikator pola szablonu niestandardowego |
|
|
Nazwa pola
|
name | string |
Nazwa pola szablonu niestandardowego |
|
|
Wartość pola
|
value | string |
Wartość pola szablonu niestandardowego |
|
|
Waluta
|
currency | string |
Waluta, np. SEK |
|
|
Lokalizacja
|
locale | string |
Ustawienia regionalne, np. sv-SE |
|
|
Wyświetlana nazwa
|
display_name | string |
Nazwa wyświetlana tabeli cen |
|
|
Tożsamość zewnętrzna
|
external_id | string |
Identyfikator zewnętrzny reprezentujący obiekt podsumowania w systemie innej firmy |
|
|
Identyfikator tabeli
|
id | string |
Identyfikator tabeli |
|
|
Wstępnie obliczone sumy
|
pre_calculated | boolean |
Jeśli sumy tabeli cenowej powinny być wstępnie obliczone |
|
|
Wyświetlana nazwa
|
display_name | string |
Nazwa wyświetlana tabeli cen |
|
|
identyfikator
|
id | string |
Identyfikator sekcji |
|
|
Wiersze
|
rows |
Tablica z obiektem wartości z tablicą column_id, wartość |
||
|
Włączona
|
enabled | boolean |
Jeśli rabat na sekcję powinien być włączony |
|
|
Opłata płaska
|
flat_fee | boolean |
Jeśli sekcja powinna korzystać z rabatów z opłatą płaską |
|
|
Wartość rabatu
|
value | string |
Wartość rabatu sekcji |
|
|
Włączona
|
enabled | boolean |
Jeśli cena sekcji powinna być włączona |
|
|
Opłata płaska
|
flat_fee | boolean |
Jeśli sekcja powinna korzystać z cennika opłaty płaskiej |
|
|
Wartość ceny
|
value | string |
Wartość ceny sekcji |
|
|
Włączona
|
enabled | boolean |
Jeśli należy włączyć podatek od sekcji |
|
|
Opłata płaska
|
flat_fee | boolean |
Jeśli sekcja powinna korzystać z podatku od opłaty płaskiej |
|
|
Wartość podatkowa
|
value | string |
Wartość podatku od sekcji |
|
|
Włączona
|
enabled | boolean |
Jeśli rabat za tabelę cenową powinien być włączony |
|
|
Opłata płaska
|
flat_fee | boolean |
Jeśli tabela cenowa powinna korzystać z rabatów z opłatą płaską |
|
|
Wartość rabatu
|
value | string |
Wartość rabatu podsumowania |
|
|
Włączona
|
enabled | boolean |
Jeśli cena tabeli cenowej powinna być włączona |
|
|
Opłata płaska
|
flat_fee | boolean |
Jeśli tabela cenowa powinna korzystać z cennika prostego |
|
|
Wartość ceny
|
value | string |
Wartość ceny podsumowania |
|
|
Włączona
|
enabled | boolean |
Jeśli należy włączyć podatek od tabeli cenowej |
|
|
Opłata płaska
|
flat_fee | boolean |
Jeśli tabela cenowa powinna korzystać z podatków z opłatą płaską |
|
|
Wartość
|
value | string |
Wartość podatku sumarykowego |
|
|
Data wygaśnięcia
|
expiration_date | date-time |
Data i godzina wygaśnięcia dokumentu |
|
|
Tożsamość zewnętrzna
|
external_id | string |
Identyfikator systemu zewnętrznego do identyfikacji |
|
|
Zawartość pliku
|
file_content | string |
Zawartość pliku zakodowanego w formacie Base64 |
|
|
Identyfikatory plików
|
file_ids | string |
Rozdzielane przecinkami unikatowe identyfikatory plików odebrane podczas przekazywania plików |
|
|
Nazwa pliku
|
file_name | string |
Nazwa pliku dokumentu z rozszerzeniem . Będzie to przydatne w przypadku konwertowania różnych typów plików. |
|
|
Adres URL pliku
|
file_url | string |
Adres URL do pliku dokumentu. Dokumenty muszą być dostępne publicznie do pobrania |
|
|
Wyślij automatycznie
|
is_automatic_sending | boolean |
Jeśli dokument powinien zostać wysłany po utworzeniu |
|
|
Wysyłanie przypomnień
|
is_reminder_sending | boolean |
W przypadku wysyłania automatycznych przypomnień |
|
|
Planowanie wysyłania
|
is_scheduled_sending | boolean |
Jeśli wysyłanie powinno zostać zaplanowane w przyszłości |
|
|
Podpisywanie dokumentu
|
is_signing | boolean |
W przypadku wysłania dokumentu do podpisania |
|
|
Podpis odręczny
|
is_signing_biometric | boolean |
Używanie podpisu odręcznego |
|
|
Zezwalaj na transfer podpisów
|
is_signing_forward | boolean |
Czy adresaci powinni mieć możliwość przeniesienia praw do podpisu |
|
|
Podpisywanie przy użyciu inicjałów
|
is_signing_initials | boolean |
Podpisywanie dokumentu przy użyciu inicjałów adresatów |
|
|
Wyślij wiadomość SMS
|
is_sms_sending | boolean |
Jeśli dokument powinien być wysyłany do adresata za pomocą tekstu |
|
|
Nazwa dokumentu
|
name | True | string |
Wprowadź nazwę dokumentu |
|
Nazwa firmy
|
company_name | string |
Nazwa firmy odbiorcy |
|
|
Numer firmy
|
company_number | string |
Numer firmy odbiorcy |
|
|
Email
|
string |
Adres e-mail odbiorcy |
||
|
Imię
|
first_name | string |
Imię adresata |
|
|
Nazwisko
|
last_name | string |
Nazwisko adresata |
|
|
Mobile
|
mobile | string |
Telefon komórkowy w formacie międzynarodowym |
|
|
Uwaga / Notatka
|
note | string |
Dodatkowa uwaga dla adresata |
|
|
Kolejność podpisywania
|
order_num | integer |
Jeśli zamówienie podpisywania jest włączone |
|
|
Typ adresata
|
role | string |
Rodzaj adresata w dokumencie |
|
|
Rola szablonu
|
role_name | string |
Nazwa roli w szablonie |
|
|
Weryfikowanie identyfikatora EID
|
verify_eid | boolean |
Weryfikowanie przy użyciu identyfikatora EID |
|
|
Typ identyfikatora EID
|
verify_eid_type | string |
Typ identyfikatora EID, który ma być używany do weryfikacji osobistej |
|
|
Włącz pytanie
|
verify_qna | boolean |
Jeśli należy zadać pytanie |
|
|
Odpowiedź na weryfikację
|
verify_qna_answer | string |
Odpowiedź na pytanie |
|
|
Pytanie otwarte
|
verify_qna_open | boolean |
Przed otwarciem dokumentu należy zadać pytanie |
|
|
Pytanie weryfikacyjne
|
verify_qna_question | string |
Pytanie, które należy zadać w celu weryfikacji |
|
|
Pytanie dotyczące podpisywania
|
verify_qna_sign | boolean |
Przed podpisaniem pytania należy zadać pytanie |
|
|
Weryfikowanie wiadomości SMS
|
verify_sms | boolean |
Weryfikowanie adresata za pomocą wiadomości SMS |
|
|
Weryfikowanie wiadomości SMS przy otwarciu
|
verify_sms_open | boolean |
Weryfikowanie wiadomości SMS przy otwarciu |
|
|
Weryfikowanie za pomocą wiadomości SMS
|
verify_sms_sign | boolean |
Jeśli wiadomość SMS zweryfikuje adresata przed podpisaniem |
|
|
Zaplanuj datę wysłania
|
scheduled_sending_time | date-time |
Data i godzina wysłania dokumentu |
|
|
Przesłanianie wiadomości e-mail nadawcy
|
sender_email | string |
Wysyłanie z innej wiadomości e-mail niż uwierzytelniony użytkownik |
|
|
Zastąpienie użytkownika nadawcy
|
sender_id | string |
Wyślij od innego użytkownika niż uwierzytelniony |
|
|
Identyfikator szablonu
|
template_id | string |
Wybierz szablon, który ma być używany do wysyłania |
|
|
Rodzaj dokumentu
|
type | string |
Ustawianie typu/kategorii dokumentu |
|
|
Wartość dokumentu
|
value | integer |
Wartość transakcji lub dokumentu |
|
|
Identyfikator wideo
|
video_id | string |
Wybierz wideo, które ma być używane do wysyłania |
Zwraca
Dokument to jeden lub wiele przekazanych plików, które mają być wysyłane do jednego lub wielu adresatów utworzonych przez użytkownika.
- Dokument
- Document
Utwórz kontakt
Spowoduje to utworzenie nowego kontaktu w bazie danych dla bieżącej jednostki
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa firmy
|
company_name | string |
Skojarzona nazwa firmy |
|
|
Numer firmy
|
company_number | string |
Skojarzony numer firmy |
|
|
Email
|
string |
Adres e-mail kontaktu |
||
|
Imię
|
first_name | string |
Imię kontaktu |
|
|
Imię i nazwisko
|
fullname | string |
Służy do określania pełnej nazwy zamiast imienia/nazwiska |
|
|
Nazwisko
|
last_name | string |
Nazwisko kontaktu |
|
|
Mobile
|
mobile | string |
Numer telefonu komórkowego w formacie międzynarodowym |
|
|
Uwaga / Notatka
|
note | string |
Opcjonalna notatka wewnętrzna kontaktu |
|
|
Telefon
|
phone | string |
Numer telefonu w formacie międzynarodowym |
|
|
Title
|
title | string |
Tytuł kontaktu, np. Dyrektor generalny, kierownik ds. sprzedaży |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator kontaktu
|
contact_id | string |
Identyfikator utworzonego kontaktu |
Utwórz użytkownika
Spowoduje to utworzenie nowego kontaktu w bazie danych dla bieżącej jednostki
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
company_name
|
company_name | string |
Skojarzona nazwa firmy |
|
|
company_number
|
company_number | string |
Skojarzony numer firmy |
|
|
e-mail
|
string |
Adres e-mail kontaktu |
||
|
first_name
|
first_name | string |
Imię kontaktu |
|
|
pełna nazwa
|
fullname | string |
Służy do określania pełnej nazwy zamiast imienia/nazwiska |
|
|
last_name
|
last_name | string |
Nazwisko kontaktu |
|
|
mobilne
|
mobile | string |
Numer telefonu komórkowego w formacie międzynarodowym |
|
|
nuta
|
note | string |
Opcjonalna notatka wewnętrzna kontaktu |
|
|
phone
|
phone | string |
Numer telefonu w formacie międzynarodowym |
|
|
title
|
title | string |
Tytuł kontaktu, np. Dyrektor generalny, kierownik ds. sprzedaży |
Zwraca
Użytkownik jest definiowany przez jego adres e-mail i jest połączony z jedną lub wieloma jednostkami.
Role użytkowników
Administrator:
- Wyświetlanie wszystkich dokumentów
- Edytuj wszystkie dokumenty
- Zmienianie ustawień jednostki, informacji i rozliczeń
- Dodawanie nowych użytkowników do jednostki
- Przypisywanie ról jednostek
Menedżer:
- Wyświetlanie dokumentów zespołu
- Edytuj wszystkie dokumenty
- Dodawanie nowych użytkowników do jednostki
Encja
Jednostka jest głównym węzłem, a wszyscy użytkownicy i odpowiednie dokumenty są połączone z jednostką. Jednostka jest często taka sama jak firma, kraj lub dział w dużej organizacji.
- User
- User
Wysyłanie istniejącego dokumentu
Po wysłaniu dokumentu za pośrednictwem polecenia GetAccept dostarczamy wiadomość e-mail do wszystkich adresatów, z których każdy zawiera unikatowy, zabezpieczony link. To wywołanie interfejsu API wyzwala akcję wysyłania dokumentu i może być wykonywane tylko na dokumentach z document_status = wersja robocza. Dokument zostanie wysłany do adresatów podanych podczas jego tworzenia.
Jeśli dokument został utworzony przy użyciu opcji samodzielnego podpisywania, zostanie również podpisany samodzielnie przez uwierzytelnionego lub określonego użytkownika przed wysłaniem.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentId | True | string |
Identyfikator dokumentu |
|
sender_email
|
sender_email |
Służy do określania użytkownika/właściciela nadawcy na podstawie adresu e-mail, który ma być używany do samodzielnego podpisywania dokumentu. |
||
|
sender_id
|
sender_id | string |
Użyj tej opcji, aby określić użytkownika/właściciela nadawcy według identyfikatora, który ma być używany do samodzielnego podpisywania dokumentu. |
Zwraca
Dokument to jeden lub wiele przekazanych plików, które mają być wysyłane do jednego lub wielu adresatów utworzonych przez użytkownika.
- Dokument
- Document
Wyświetlanie listy dokumentów
Pobieranie listy dostępnych dokumentów
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Lista filtrów w stanie
|
filter | string |
Lista filtrów w stanie |
|
|
Jak sortować wyniki
|
sort_by | string |
Jak sortować wyniki |
|
|
Kolejność sortowania wyników
|
sort_order | string |
Kolejność sortowania wyników |
|
|
Dołączanie dokumentów od członków zespołu
|
showteam | boolean |
Dołączanie dokumentów od członków zespołu |
|
|
Uwzględnij wszystkie dokumenty z jednostki
|
showall | boolean |
Uwzględnij wszystkie dokumenty z jednostki |
|
|
Tożsamość zewnętrzna
|
external_id | string |
Identyfikator zewnętrzny to pole niestandardowe, które może zawierać unikatowy identyfikator rekordu z systemu spoza polecenia GetAccept |
|
|
Przesunięcie
|
offset | number |
Rozpoczynanie listy z rekordu x do limitu |
|
|
Ograniczenie
|
limit | number |
Liczba rekordów do wyświetlenia |
Zwraca
Lista dokumentów
- Przedmioty
- Documents
Wyświetlanie listy filmów wideo
Odbieranie listy dostępnych filmów wideo w jednostce. Możesz dodać nowe filmy wideo w aplikacji mobilnej lub wewnątrz aplikacji GetAccept.
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
videos
|
videos | array of object | |
|
edytowalny
|
videos.editable | boolean | |
|
Opublikowany
|
videos.published | boolean | |
|
Zapisano
|
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 |
Wyświetlanie listy kontaktów
Odbierz listę dostępnych kontaktów dla bieżącej jednostki. Wszystkie kontakty dodane jako adresat są zapisywane jako kontakt i są dostępne do późniejszego użycia w tej jednostce.
Zwraca
Lista kontaktów
- Kontakty
- Contacts
Wyświetlanie listy użytkowników
Pobieranie listy aktywnych użytkowników dla bieżącej uwierzytelnionej jednostki
Zwraca
Lista użytkowników
- Użytkownicy
- Users
Wyświetlanie listy załączników
Otrzymuj listę dostępnych załączników. Nowe załączniki można dodać w programie GetAccept przy użyciu nowego dokumentu.
Zwraca
Lista załączników
- Załączniki
- Attachments
Wyzwalacze
| Po odrzuceniu dokumentu |
Wyzwala, gdy dokument został odrzucony przez dowolnego adresata |
| Po podpisaniu dokumentu |
Wyzwala, gdy dokument został podpisany przez wszystkie strony podpisywania |
| Po przejrzeniu dokumentu |
Wyzwala, gdy dokument został przejrzyony przez dowolnego adresata |
| Subskrybowanie zdarzeń dokumentu |
To wywołanie spowoduje utworzenie nowej subskrypcji. Odpowiedź zostanie opakowana w tablicę nawet dla pojedynczego obiektu zgodnie ze standardami punktów zaczepienia REST.
|
Po odrzuceniu dokumentu
Wyzwala, gdy dokument został odrzucony przez dowolnego adresata
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wszyscy użytkownicy jednostek
|
global | boolean |
Jeśli element webhook powinien przechwytywać zdarzenia dla wszystkich użytkowników jednostek. |
|
|
Wiadomość e-mail o błędzie
|
notification_email | string |
Jeśli zdarzenie zakończy się niepowodzeniem, wyślij powiadomienie do tej wiadomości e-mail zamiast nadawcy |
|
|
Ładunek
|
payload | string |
Dodatkowe dane ładunku do opublikowania |
Zwraca
Ładunek webhooka
- Webhook
- Webhook
Po podpisaniu dokumentu
Wyzwala, gdy dokument został podpisany przez wszystkie strony podpisywania
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wszyscy użytkownicy jednostek
|
global | boolean |
Jeśli element webhook powinien przechwytywać zdarzenia dla wszystkich użytkowników jednostek. |
|
|
Wiadomość e-mail o błędzie
|
notification_email | string |
Jeśli zdarzenie zakończy się niepowodzeniem, wyślij powiadomienie do tej wiadomości e-mail zamiast nadawcy |
|
|
Ładunek
|
payload | string |
Dodatkowe dane ładunku do opublikowania |
Zwraca
Ładunek webhooka
- Webhook
- Webhook
Po przejrzeniu dokumentu
Wyzwala, gdy dokument został przejrzyony przez dowolnego adresata
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wszyscy użytkownicy jednostek
|
global | boolean |
Jeśli element webhook powinien przechwytywać zdarzenia dla wszystkich użytkowników jednostek. |
|
|
Wiadomość e-mail o błędzie
|
notification_email | string |
Jeśli zdarzenie zakończy się niepowodzeniem, wyślij powiadomienie do tej wiadomości e-mail zamiast nadawcy |
|
|
Ładunek
|
payload | string |
Dodatkowe dane ładunku do opublikowania |
Zwraca
Ładunek webhooka
- Webhook
- Webhook
Subskrybowanie zdarzeń dokumentu
To wywołanie spowoduje utworzenie nowej subskrypcji. Odpowiedź zostanie opakowana w tablicę nawet dla pojedynczego obiektu zgodnie ze standardami punktów zaczepienia REST.
Events
-
document.created— Dokument jest tworzony -
document.sent- Dokument jest wysyłany -
document.viewed- Dokument jest wysyłany -
document.signed- Dokument jest podpisany -
document.approved- Dokument jest zatwierdzony -
document.expired— Dokument wygasł -
document.rejected— Dokument jest odrzucany -
document.downloaded— Dokument jest pobierany -
document.printed- Dokument jest drukowany -
document.forwarded- Dokument jest przekazywany -
document.partially_signed- Dokument został częściowo podpisany -
document.commented— Dokument jest komentowany -
document.hardbounced- Dokument jest hardbounced -
document.imported— Importowany jest dokument
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wybierz zdarzenie
|
event | True | string |
Wyzwalacz zdarzenia |
|
Wszyscy użytkownicy jednostek
|
global | boolean |
Jeśli element webhook powinien przechwytywać zdarzenia dla wszystkich użytkowników jednostek. |
|
|
Wiadomość e-mail o błędzie
|
notification_email | string |
Jeśli zdarzenie zakończy się niepowodzeniem, wyślij powiadomienie do tej wiadomości e-mail zamiast nadawcy |
|
|
Ładunek
|
payload | string |
Dodatkowe dane ładunku do opublikowania |
Zwraca
Ładunek webhooka
- Webhook
- Webhook
Definicje
Attachment
Załącznik dokumentu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Dostęp do adresatów
|
access_recipient_names | array of string |
Adresaci z dostępem do załącznika |
|
Description
|
attachment_description | string |
Opis załącznika |
|
Adres URL pobierania
|
attachment_download_url | string |
Adres URL pobierania załącznika |
|
Formatem
|
attachment_extension | string |
Rozszerzenie pliku załącznika |
|
Filename
|
attachment_filename | string |
Nazwa pliku załącznika |
|
identyfikator
|
attachment_id | string |
Identyfikator załącznika |
|
Adres URL podglądu
|
attachment_preview_url | string |
Wewnętrzny adres URL podglądu załącznika |
|
Title
|
attachment_title | string |
Tytuł załącznika |
|
Typ
|
attachment_type | string |
Typ załącznika |
|
adres URL
|
attachment_url | string |
Adres URL załącznika |
|
Ostatni widok
|
last_attachment_view | string |
Data i godzina ostatniego wyświetlenia załącznika |
|
Dostęp ograniczony
|
restrict_access | boolean |
Załącznik ma ograniczony dostęp |
Załączniki
Lista załączników
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
attachments
|
attachments | array of Attachment |
Kontakt
Każdy unikatowy adres e-mail (lub numer telefonu komórkowego) jest definiowany jako kontakt.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator firmy
|
company_id | string |
Identyfikator firmy |
|
Logo firmy
|
company_logo_url | string |
Logo firmy |
|
Nazwa firmy
|
company_name | string |
Nazwa firmy kontaktu |
|
Numer firmy
|
company_number | string |
Numer firmy kontaktu |
|
Identyfikator kontaktu
|
contact_id | string |
Identyfikator kontaktu |
|
Created
|
created_at | string |
Data utworzenia kontaktu |
|
Documents
|
document_count | number |
Liczba dokumentów kontaktu |
|
Kontaktowy adres e-mail
|
string |
Nazwa utworzonego dokumentu |
|
|
Imię
|
first_name | string |
Imię kontaktu |
|
Imię i nazwisko
|
fullname | string |
Imię i nazwisko kontaktu |
|
Gender
|
gender | string |
Płeć odbiorcy |
|
Nazwisko
|
last_name | string |
Nazwisko kontaktu |
|
Mobile
|
mobile | string |
Numer telefonu komórkowego kontaktu |
|
Uwaga / Notatka
|
note | string |
Zanotuj kontakt |
|
Adres URL kciuka
|
thumb_url | string |
Adres URL kciuka kontaktu |
|
Title
|
title | string |
Tytuł kontaktu |
Kontakty
Lista kontaktów
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
contacts
|
contacts | array of Contact |
Dokument
Dokument to jeden lub wiele przekazanych plików, które mają być wysyłane do jednego lub wielu adresatów utworzonych przez użytkownika.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Etykiety
|
tags | string |
Tagi dokumentów |
|
Automatyczny tekst czatu
|
auto_comment_text | string |
Automatyczny tekst czatu |
|
Nazwa firmy
|
company_name | string |
Nazwa firmy |
|
Utworzono w
|
created_at | string |
Kiedy dokument został utworzony |
|
Adres URL pobierania
|
download_url | string |
Adres URL pobierania podpisanego dokumentu |
|
Wiadomość e-mail
|
email_send_message | string |
Wysyłanie wiadomości e-mail |
|
Temat wiadomości e-mail
|
email_send_subject | string |
Tekst tematu wiadomości e-mail |
|
Data wygaśnięcia
|
expiration_date | string |
Data wygaśnięcia dokumentu |
|
Identyfikator klienta zewnętrznego
|
external_client_id | string | |
|
Identyfikator edytora zewnętrznego
|
external_editor_id | string |
Identyfikator w edytorze zewnętrznym |
|
Typ edytora zewnętrznego
|
external_editor_type | string | |
|
Tożsamość zewnętrzna
|
external_id | string | |
|
Liczba pól
|
field_count | integer |
Liczba pól w dokumencie |
|
identyfikator
|
id | string | |
|
Automatyczne komentowanie
|
is_auto_comment | boolean |
Jeśli jest włączony automatyczny komentarz do czatu |
|
Wiadomość e-mail z automatycznym komentarzem
|
is_auto_comment_email | boolean |
Jeśli włączono automatyczną wiadomość e-mail z czatem |
|
Identyfikowanie adresata
|
is_identify_recipient | boolean |
Jeśli dokument ma włączoną identyfikację adresata |
|
Jest prywatny
|
is_private | boolean |
Jeśli dokument jest prywatny |
|
Wysyłanie przypomnień
|
is_reminder_sending | boolean |
Jeśli automatyczne przypomnienia są włączone |
|
Zaplanowane wysyłanie
|
is_scheduled_sending | boolean |
Jeśli dokument ma zaplanowane wysyłanie |
|
Samodzielne podpisywanie
|
is_selfsign | boolean |
Jeśli dokument został podpisany samodzielnie przez nadawcę |
|
Jest podpisany
|
is_signed | boolean |
Jeśli dokument został podpisany |
|
Dokument z możliwością podpisywania
|
is_signing | boolean |
Jeśli dokument jest podpisywalny |
|
Podpis odręczny
|
is_signing_biometric | boolean |
Jeśli włączono podpis odręczny |
|
Zezwalaj na transfer podpisów
|
is_signing_forward | boolean |
W przypadku włączenia przenoszenia praw podpisywania |
|
Kolejność podpisów
|
is_signing_order | boolean |
Jeśli zamówienie podpisywania adresata jest włączone |
|
Ma wideo
|
is_video | boolean |
Jeśli dokument zawiera wprowadzenie wideo |
|
Name
|
name | string |
Nazwa dokumentu |
|
Identyfikator nadrzędny
|
parent_id | string |
Identyfikator poprzedniej wersji dokumentu |
|
Adres URL podglądu
|
preview_url | string |
Link do wewnętrznej wersji zapoznawczej dokumentu |
|
recipients
|
recipients | array of Recipient | |
|
Zaplanowany czas wysyłania
|
scheduled_sending_time | string |
Kiedy dokument został zaplanowany na wysyłanie |
|
Data wysłania
|
send_date | string |
Data wysłania dokumentu |
|
Adres e-mail nadawcy
|
sender_email | string |
Adres e-mail użytkownika nadawcy |
|
Nazwa nadawcy
|
sender_name | string |
Nazwa użytkownika nadawcy |
|
Adres URL kciuka nadawcy
|
sender_thumb_url | string |
Obraz palca użytkownika nadawcy |
|
Data podpisania
|
sign_date | string |
Data podpisania dokumentu |
|
Status
|
status | string |
Bieżący stan dokumentu |
|
Adres URL kciuka
|
thumb_url | string |
Obraz kciuka dokumentu |
|
Typ
|
type | string |
Rodzaj dokumentu |
|
Unikatowy identyfikator
|
unique_id | integer |
Unikatowy identyfikator dokumentu |
|
Identyfikator użytkownika
|
user_id | string |
Identyfikator użytkownika nadawcy |
|
Wartość
|
value | integer |
Wartość dokumentu |
Documents
Lista dokumentów
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
tags
|
tags | string | |
|
company_name
|
company_name | string | |
|
utworzono_o
|
created_at | string | |
|
expiration_date
|
expiration_date | string | |
|
id
|
id | string | |
|
is_private
|
is_private | boolean | |
|
is_signing
|
is_signing | boolean | |
|
nazwa
|
name | string | |
|
sender_name
|
sender_name | string | |
|
sender_thumb
|
sender_thumb | string | |
|
stan
|
status | string | |
|
typ
|
type | string | |
|
value
|
value | integer |
Pole edytora
Szczegóły pola edytora
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
identyfikator |
|
Etykieta
|
input_settings.label | string |
Etykieta |
|
Opcje
|
input_settings.options | array of string |
Opcje |
|
Wymagane
|
input_settings.required | boolean |
Wymagane |
|
Typ
|
input_settings.type | string |
Typ |
|
Identyfikator adresata
|
recipient_id | string |
Identyfikator adresata |
|
Typ
|
type | string |
Typ |
|
Identyfikator użytkownika
|
user_id | string |
Identyfikator użytkownika |
(No changes needed)
Szczegóły pola
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Nazwa firmy
|
company_name | string |
Nazwa firmy |
|
Numer firmy
|
company_number | string |
Numer firmy |
|
Identyfikator pola
|
field_id | string |
Identyfikator pola |
|
Etykieta
|
field_label | string |
Etykieta |
|
Opcje
|
field_options | array of object |
Opcje |
|
Wartość
|
field_options.value | string | |
|
Typ
|
field_type | string |
Typ |
|
Wartość
|
field_value | string |
Wartość |
|
is_collectable
|
is_collectable | boolean |
Zbieranie pola |
|
is_editable
|
is_editable | boolean |
Pole edytowalne |
|
is_required
|
is_required | boolean |
Pole wymagane |
|
Identyfikator strony
|
page_id | string |
Identyfikator strony |
|
Identyfikator adresata
|
recipient_id | string |
Identyfikator adresata |
|
Nazwa adresata
|
recipient_name | string |
Nazwa adresata |
|
Nazwa roli
|
role_name | string |
Nazwa roli |
Pola formularza
Lista pól
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
editor_fields
|
editor_fields | array of EditorField | |
|
pola
|
fields | array of Field |
Kolumna cenowa
Kolumna tabeli cenowej
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
column_id | string |
identyfikator |
|
Wyświetlana nazwa
|
display_name | string |
Wyświetlana nazwa |
|
Włączona
|
enabled | boolean |
Włączona |
|
Name
|
name | string |
Name |
CennikAkcja
Sekcja tabeli cen
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
columns
|
columns | array of PricingColumn | |
|
Wyświetlana nazwa
|
display_name | string |
Wyświetlana nazwa |
|
Name
|
name | string |
Name |
|
identyfikator
|
section_id | string |
identyfikator |
Tabela cenowa
Tabela cen
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Waluta
|
currency_settings.currency | string |
Waluta |
|
Lokalizacja
|
currency_settings.locale | string |
Lokalizacja |
|
Wstępnie obliczone sumy
|
pre_calculated | boolean |
Wstępnie obliczone sumy |
|
Sekcje
|
sections | array of PricingSection | |
|
identyfikator
|
table_id | string |
Identyfikator tabeli |
Tabele cenowe
Tabele cen
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
pricing_tables
|
pricing_tables | array of PricingTable |
Recipient
Każdy unikatowy adres e-mail (lub numer telefonu komórkowego) połączony z dokumentem jest adresatem.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Nazwa firmy
|
company_name | string |
Nazwa firmy odbiorcy |
|
Numer firmy
|
company_number | string |
Numer firmy odbiorcy |
|
Adres URL dokumentu
|
document_url | string |
Unikatowy adres URL odbiorcy do wyświetlania/podpisywania |
|
Adres e-mail adresata
|
string |
Adres e-mail odbiorcy |
|
|
Imię
|
first_name | string |
Imię odbiorcy |
|
Imię i nazwisko
|
fullname | string |
Pełna nazwa odbiorcy |
|
Gender
|
gender | string |
Płeć odbiorcy |
|
identyfikator
|
id | string |
Identyfikator odbiorcy |
|
Nazwisko
|
last_name | string |
Nazwisko odbiorcy |
|
Mobile
|
mobile | string |
Numer telefonu komórkowego odbiorcy |
|
Uwaga / Notatka
|
note | string |
Zanotuj adresata |
|
Numer zamówienia podpisywania
|
order_num | string |
Kolejność podpisywania adresata |
|
Status
|
status | string |
Stan adresata |
|
Adres URL kciuka
|
thumb_url | string |
Adres URL kciuka odbiorcy |
|
Title
|
title | string |
Tytuł adresata |
Adresatów
Lista adresatów
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
recipients
|
recipients | array of Recipient |
User
Użytkownik jest definiowany przez jego adres e-mail i jest połączony z jedną lub wieloma jednostkami.
Role użytkowników
Administrator:
- Wyświetlanie wszystkich dokumentów
- Edytuj wszystkie dokumenty
- Zmienianie ustawień jednostki, informacji i rozliczeń
- Dodawanie nowych użytkowników do jednostki
- Przypisywanie ról jednostek
Menedżer:
- Wyświetlanie dokumentów zespołu
- Edytuj wszystkie dokumenty
- Dodawanie nowych użytkowników do jednostki
Encja
Jednostka jest głównym węzłem, a wszyscy użytkownicy i odpowiednie dokumenty są połączone z jednostką. Jednostka jest często taka sama jak firma, kraj lub dział w dużej organizacji.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Tryb aplikacji
|
app_mode | string | |
|
disallow_create
|
disallow_create | boolean | |
|
Email
|
string |
Adres e-mail użytkownika |
|
|
Identyfikator jednostki
|
entity_id | string | |
|
Nazwa encji
|
entity_name | string | |
|
Imię
|
first_name | string |
Imię użytkownika |
|
identyfikator
|
id | string |
Identyfikator użytkownika |
|
Język
|
language | string | |
|
Nazwisko
|
last_name | string |
Nazwisko użytkownika |
|
mobilne
|
mobile | string |
Numer telefonu komórkowego w formacie międzynarodowym |
|
Uwaga / Notatka
|
note | string |
Opcjonalna notatka wewnętrzna dla użytkownika |
|
Telefon
|
phone | string |
Numer telefonu w formacie międzynarodowym |
|
Role
|
role | string | |
|
Pomiń wysyłanie zaproszenia
|
skip_invitation | boolean | |
|
Status
|
status | string | |
|
Identyfikator zespołu
|
team_id | string | |
|
Adres URL kciuka
|
thumb_url | string | |
|
Timezone
|
timezone | string | |
|
Title
|
title | string |
Tytuł użytkownika, np. Dyrektor generalny, kierownik ds. sprzedaży |
Użytkownicy
Lista użytkowników
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
users
|
users | array of object | |
|
Email
|
users.email | string | |
|
Imię
|
users.first_name | string | |
|
Ostatnie logowanie
|
users.last_login | string | |
|
Nazwisko
|
users.last_name | string | |
|
Nazwa użytkownika
|
users.name | string | |
|
Role
|
users.role | string | |
|
Status
|
users.status | string | |
|
Nazwa zespołu
|
users.team_name | string | |
|
Identyfikator użytkownika
|
users.user_id | string |
Webhook
Ładunek webhooka
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Pola niestandardowe
|
custom_fields | object | |
|
Dokument
|
document | Document |
Dokument to jeden lub wiele przekazanych plików, które mają być wysyłane do jednego lub wielu adresatów utworzonych przez użytkownika. |
|
Domena niestandardowa jednostki
|
entity.custom_domain | string |
Ustawienie domeny niestandardowej dla jednostki |
|
Domyślna wiadomość e-mail
|
entity.email_send_message | string |
Domyślna wiadomość e-mail |
|
Domyślny temat wiadomości e-mail
|
entity.email_send_subject | string |
Domyślny temat wiadomości e-mail |
|
Domena podrzędna jednostki
|
entity.sub_domain | string |
Domena podrzędna dla jednostki |
|
Nazwa zdarzenia
|
event | string | |
|
Akcja zdarzenia
|
event_action | string | |
|
Typ zdarzenia
|
event_type | string | |
|
Recipient
|
recipient | Recipient |
Każdy unikatowy adres e-mail (lub numer telefonu komórkowego) połączony z dokumentem jest adresatem. |
|
Identyfikator subskrypcji
|
subscription_id | string |