GetAccept
GetAccept, satış teminatı, sözleşme yönetimi, teklifler ve elektronik imzalardan tek bir yerde yararlanarak satış belgelerini tasarlamak, göndermek, tanıtmak, izlemek ve e-imzalamak için satış için bir satış etkinleştirme platformu sağlar.
Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:
| Hizmet | Class | Bölgeler |
|---|---|---|
| Copilot Studio | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Logic Apps | Standart | Aşağıdakiler dışında tüm Logic Apps bölgeleri : - Azure Kamu bölgeleri - Azure Çin bölgeleri - ABD Savunma Bakanlığı (DoD) |
| Power Apps | Premium | Aşağıdakiler dışında tüm Power Apps bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Power Automate | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| İletişim | |
|---|---|
| İsim | GetAccept API Ekibi |
| URL | https://app.getaccept.com/api |
| E-posta | integrations@getaccept.com |
| Bağlayıcı Meta Verileri | |
|---|---|
| Publisher | GetAccept, Inc. |
| Web sitesi | https://www.getaccept.com |
| Gizlilik ilkesi | https://www.getaccept.com/privacy-policy |
| Kategoriler | Satış ve CRM; Verimli -lik |
GetAccept, satış teminatı, sözleşme yönetimi, teklifler ve elektronik imzalardan tek bir yerde yararlanarak satış belgelerini tasarlamak, göndermek, tanıtmak, izlemek ve e-imzalamak için satış için bir satış etkinleştirme platformu sağlar. Bu bağlayıcı, belge depolama, alma, görev ataması ve özelleştirilmiş bildirimler için iş akışlarınızı otomatikleştirmeye yardımcı olur.
Önkoşullar
Bu bağlantıyı kullanmak için bir GetAccept hesabı gereklidir. Ücretsiz bir hesap kaydetmek için getaccept.com gidin.
Kimlik bilgileri nasıl alınıyor?
GetAccept'te oturum açmış geçerli kullanıcının kimliğini doğrulamak için OAuth2 kullanıldığından yalnızca geçerli bir GetAccept hesabı gereklidir.
Bilinen sorunlar ve sınırlamalar
Tümleştirmeyle ilgili sorunlar için lütfen [mailto:support@getaccept.com](teknik destek) ile iletişime geçin.
Azaltma Sınırları
| Name | Çağrılar | Yenileme Dönemi |
|---|---|---|
| Bağlantı başına API çağrıları | 100 | 60 saniye |
Eylemler
| Belge alanlarını alma |
Belge veya şablon için alanların listesini alma. Belge imzalandıktan önce ve sonra kullanılabilir. |
| Belge alıcılarını alma |
Belirli bir belge için alıcıların listesini alma. |
| Belge ayrıntılarını alma |
Belge kimliğini belirterek belge ayrıntılarını alın. |
| Belge dosyasını karşıya yükleme |
Bir kerede bir dosyayı karşıya yükleyebilir ve bir dosya kimliği alabilirsiniz. Dosya kimliği, alıcılara gönderilen getAccept belgesine bir dosya bağlamak için kullanılır. Mutliple dosyalarını karşıya yüklemek istiyorsanız birden çok POST çalıştırabilirsiniz. Varsayılan olarak yalnızca 10 MB'a kadar olan dosyaları kabul ediyoruz. Karşıya yüklenen dosyanın karşıya yüklendikten sonraki 48 saat içinde içeri aktarılması/belgeye eklenmesi gerekir. Gönderildiğinde aynı görünümü garanti etmek için PDF dosyalarını karşıya yüklemenizi öneririz. Diğer dosya türleri dönüştürülebilir, örneğin: Mirosoft Office: doc, docx, xl, xls, xls, xlsx, ppt, pptx Mac: numbers, key Images: jpg, jpeg, png Diğer: html, tex, csv |
| Belge eklerini alma |
Belge kimliğini belirterek belge eklerini alın. |
| Belge veya şablon oluşturma ve gönderme |
Belgeyi bir alıcıya gönderebilmek için oluşturmanız gerekir. Belge oluştururken, file_id ile daha önce karşıya yüklenen dosyalara başvurabilir veya bir belge oluşturup dosyaları API gönderisine yüklemeyi seçebilirsiniz. Belge oluşturma POST'unda bir dosya eklerken yalnızca ONE dosyasını karşıya yükleyebilirsiniz. Var olan karşıya yüklenen dosyaları kullanmak için file_ids parametresini kullanın, file_content belgeyi base64 kodlanmış dize olarak gönderin veya dosya parametresiyle çok parçalı bir gönderi yapın. Tüm alıcıların geçerli bir e-posta veya cep telefonu numarası olmalıdır. Tüm olaylar istek sahibi IP adresi kullanılarak kaydedilir. Son kullanıcıların genel IP adresini içeren üst bilgi CLIENT_IP kullanarak bunu geçersiz kılabilirsiniz. |
| Belgeleri listeleme |
Kullanılabilir belgelerin listesini alma |
| Belgenin süre sonunu güncelleştirme |
Belgenin son kullanma tarihini ve saatini güncelleştirmek için bu yöntemi kullanın. |
| Belgeyi indirme |
Belge dosyası her zaman indirilebilir, ancak büyük olasılıkla durumu İmzalı olduğunda indirmek istersiniz. İndirme url'si almayı veya ikili dosyayı almayı seçebilirsiniz. İndirme URL'sine bir istek yapıldıktan 10 dakika sonra erişilebilir. |
| Eki karşıya yükleme |
Gönderdiğiniz belgelere eklemek için ek dosyalarını karşıya yükleyebilirsiniz. Başarılı istek attachment_id döndürür. Belgeye ek atamak için attachment_id kullanın. |
| Ekleri listeleme |
Kullanılabilir eklerin listesini alın. Yeni bir belge kullanarak GetAccept'e yeni ekler ekleyebilirsiniz. |
| İlgili kişi oluştur |
Bu, geçerli varlık için veritabanında yeni bir kişi oluşturur |
| Kişileri listeleme |
Geçerli varlık için kullanılabilir kişinin listesini alın. Alıcı olarak eklenen tüm kişiler kişi olarak kaydedilir ve daha sonra bu varlıkta kullanılabilir. |
| Kullanıcı ayrıntılarını alma |
Bu çağrı, tek bir kullanıcının ayrıntılarını döndürür. User-id me kullanarak geçerli kimliği doğrulanmış kullanıcının ayrıntılarını ve kullanılabilir varlıklarını alma |
| Kullanıcı oluşturma |
Bu, geçerli varlık için veritabanında yeni bir kişi oluşturur |
| Kullanıcıları listeleme |
Geçerli kimliği doğrulanmış varlık için etkin kullanıcıların listesini getirme |
| Liste şablonları |
Kullanılabilir belge şablonlarının listesini alın. GetAccept'teki Templates-bölümünün altına yeni şablonlar ekleyebilirsiniz. |
| Var olan belgeyi gönder |
GetAccept aracılığıyla bir belge gönderdiğinizde, her biri benzersiz, güvenli bir bağlantı içeren bir e-postayı tüm alıcılara göndeririz. Bu API çağrısı, belge gönderme eylemini tetikler ve yalnızca document_status = taslak içeren belgeler üzerinde gerçekleştirilebilir. Belge, oluşturulduğu sırada sağladığınız alıcılara gönderilir. Belge otomatik imza seçeneği kullanılarak oluşturulduysa, göndermeden önce kimliği doğrulanmış veya belirtilen kullanıcı tarafından da otomatik olarak imzalanır. |
| Video yükleme |
Gönderdiğiniz belgelere eklemek için ek dosyalarını karşıya yükleyebilirsiniz. Başarılı istek attachment_id döndürür. Belgeye ek atamak için attachment_id kullanın. |
| Videoları listeleme |
Varlıkta kullanılabilir videoların listesini alın. Mobil uygulamaya veya GetAccept içine yeni videolar ekleyebilirsiniz. |
| Şablon alanlarını alma |
Belirli bir şablon için alanların listesini alma. |
| Şablon fiyatlandırma tablolarını alma |
Belirli bir şablon için fiyatlandırma tablosu öğelerinin listesini alın. |
| Şablon rollerini alma |
Belirli bir şablon için rollerin listesini alma. |
Belge alanlarını alma
Belge veya şablon için alanların listesini alma. Belge imzalandıktan önce ve sonra kullanılabilir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Belge Kimliği
|
documentId | True | string |
Belge Kimliği |
Döndürülenler
Alan listesi
- Fields
- Fields
Belge alıcılarını alma
Belirli bir belge için alıcıların listesini alma.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Belge Kimliği
|
documentId | True | string |
Belge Kimliği |
Döndürülenler
Alıcı listesi
- Alıcı
- Recipients
Belge ayrıntılarını alma
Belge kimliğini belirterek belge ayrıntılarını alın.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Belge Kimliği
|
documentId | True | string |
Belge Kimliği |
Döndürülenler
Belge, bir kullanıcı tarafından oluşturulan bir veya birden çok alıcıya gönderilecek bir veya birden çok karşıya yüklenen dosyadır.
- Belge
- Document
Belge dosyasını karşıya yükleme
Bir kerede bir dosyayı karşıya yükleyebilir ve bir dosya kimliği alabilirsiniz. Dosya kimliği, alıcılara gönderilen getAccept belgesine bir dosya bağlamak için kullanılır. Mutliple dosyalarını karşıya yüklemek istiyorsanız birden çok POST çalıştırabilirsiniz. Varsayılan olarak yalnızca 10 MB'a kadar olan dosyaları kabul ediyoruz. Karşıya yüklenen dosyanın karşıya yüklendikten sonraki 48 saat içinde içeri aktarılması/belgeye eklenmesi gerekir.
Gönderildiğinde aynı görünümü garanti etmek için PDF dosyalarını karşıya yüklemenizi öneririz. Diğer dosya türleri dönüştürülebilir, örneğin:
Mirosoft Office: doc, docx, xl, xls, xls, xlsx, ppt, pptx Mac: numbers, key Images: jpg, jpeg, png Diğer: html, tex, csv
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Dosya içeriği
|
file_content | string |
Dosyayı base64 kodlanmış olarak gönderin. Base64 kodlama dosyalarının dosya boyutunu yaklaşık 30% artıracağını unutmayın |
|
|
Dosya adı
|
file_name | string |
Uzantılı belgenin dosya adı. Bu, farklı dosya türlerini dönüştürmek için yararlı olacaktır. |
|
|
Dosya URL'si
|
file_url | string |
Belge dosyasının URL'si. Dosyanın herhangi bir yetkilendirme olmadan indirilebilmesi gerekir |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
dosya_kimlik
|
file_id | string |
Belge oluştururken file_ids kullanılacak karşıya yüklenen dosyanın kimliği |
|
file_status
|
file_status | string |
Karşıya yüklenen dosyanın durumu |
Belge eklerini alma
Belge kimliğini belirterek belge eklerini alın.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Belge Kimliği
|
documentId | True | string |
Belge Kimliği |
Döndürülenler
Ek listesi
- Attachments
- Attachments
Belge veya şablon oluşturma ve gönderme
Belgeyi bir alıcıya gönderebilmek için oluşturmanız gerekir. Belge oluştururken, file_id ile daha önce karşıya yüklenen dosyalara başvurabilir veya bir belge oluşturup dosyaları API gönderisine yüklemeyi seçebilirsiniz. Belge oluşturma POST'unda bir dosya eklerken yalnızca ONE dosyasını karşıya yükleyebilirsiniz.
Var olan karşıya yüklenen dosyaları kullanmak için file_ids parametresini kullanın, file_content belgeyi base64 kodlanmış dize olarak gönderin veya dosya parametresiyle çok parçalı bir gönderi yapın.
Tüm alıcıların geçerli bir e-posta veya cep telefonu numarası olmalıdır.
Tüm olaylar istek sahibi IP adresi kullanılarak kaydedilir. Son kullanıcıların genel IP adresini içeren üst bilgi CLIENT_IP kullanarak bunu geçersiz kılabilirsiniz.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kimlik
|
id | string |
Listeden veya karşıya yüklemeden sonra alınan ek kimliği |
|
|
Görünüm gerektir
|
require_view | boolean |
Alıcının eki görüntülemesini gerektir |
|
|
Türü
|
type | string |
dosya veya dış konum dosyası karşıya yüklenen bir dosya, dış dosya ise bir dış dosyanın bağlantısıdır |
|
|
Alan Kimliği
|
id | string |
Özel şablon alanının kimliği |
|
|
Alan Adı
|
name | string |
Özel şablon alanının adı |
|
|
Alan Değeri
|
value | string |
Özel şablon alanının değeri |
|
|
Para birimi
|
currency | string |
Para birimi, örn. SEK |
|
|
Locale
|
locale | string |
Yerel ayar, örn. sv-SE |
|
|
Görüntü adı
|
display_name | string |
Fiyatlandırma tablosunun görünen adı |
|
|
Dış Kimlik
|
external_id | string |
Üçüncü taraf sistem içindeki özet nesnesini temsil eden dış kimlik |
|
|
Tablo Kimliği
|
id | string |
Tablo Kimliği |
|
|
Önceden hesaplanmış toplamlar
|
pre_calculated | boolean |
Fiyatlandırma tablosu toplamlarının önceden hesaplanması gerekiyorsa |
|
|
Görüntü adı
|
display_name | string |
Fiyatlandırma tablosunun görünen adı |
|
|
Kimlik
|
id | string |
Bölüm Kimliği |
|
|
Rows
|
rows |
column_id dizisine sahip values nesnesine sahip dizi, değer |
||
|
Etkinleştirildi
|
enabled | boolean |
Bölüm indirimi etkinleştirilmeliyse |
|
|
Sabit ücret
|
flat_fee | boolean |
Bölüm, sabit ücret indirimleri kullanılarak kullanılacaksa |
|
|
İndirim Değeri
|
value | string |
Bölüm indirimi değeri |
|
|
Etkinleştirildi
|
enabled | boolean |
Bölüm fiyatının etkinleştirilmesi gerekiyorsa |
|
|
Sabit ücret
|
flat_fee | boolean |
Bölüm, sabit ücret fiyatlandırması kullanılarak kullanılacaksa |
|
|
Fiyat Değeri
|
value | string |
Bölüm fiyatı değeri |
|
|
Etkinleştirildi
|
enabled | boolean |
Bölüm vergisinin etkinleştirilmesi gerekiyorsa |
|
|
Sabit ücret
|
flat_fee | boolean |
Bölüm, sabit ücret vergileri kullanılarak kullanılacaksa |
|
|
Vergi Değeri
|
value | string |
Bölüm vergisi değeri |
|
|
Etkinleştirildi
|
enabled | boolean |
Fiyatlandırma tablosu indirimi etkinleştirilmelidir |
|
|
Sabit ücret
|
flat_fee | boolean |
Fiyatlandırma tablosunun sabit ücret indirimleri kullanılarak kullanılması gerekiyorsa |
|
|
İndirim Değeri
|
value | string |
Özet indirim değeri |
|
|
Etkinleştirildi
|
enabled | boolean |
Fiyatlandırma tablosu fiyatının etkinleştirilmesi gerekiyorsa |
|
|
Sabit ücret
|
flat_fee | boolean |
Fiyatlandırma tablosunun sabit ücret fiyatlandırması kullanılarak kullanılması gerekiyorsa |
|
|
Fiyat Değeri
|
value | string |
Özet fiyat değeri |
|
|
Etkinleştirildi
|
enabled | boolean |
Fiyatlandırma tablosu vergisinin etkinleştirilmesi gerekiyorsa |
|
|
Sabit ücret
|
flat_fee | boolean |
Fiyatlandırma tablosunun sabit ücret vergileri kullanılarak kullanılması gerekiyorsa |
|
|
Değer
|
value | string |
Özet vergi değeri |
|
|
Son kullanma tarihi
|
expiration_date | date-time |
Belgenin süresinin dolması gereken tarih ve saat |
|
|
Dış Kimlik
|
external_id | string |
Tanımlama için dış sistem kimliği |
|
|
Dosya içeriği
|
file_content | string |
Base64 kodlanmış dosya içeriği |
|
|
Dosya Kimlikleri
|
file_ids | string |
Dosyaları karşıya yüklerken alınan virgülle ayrılmış, benzersiz dosya kimlikleri |
|
|
Dosya adı
|
file_name | string |
Uzantılı belgenin dosya adı. Bu, farklı dosya türlerini dönüştürmek için yararlı olacaktır. |
|
|
Dosya URL'si
|
file_url | string |
Belge dosyasının URL'si. Belgelerin indirilebilmesi için genel kullanıma açık olması gerekir |
|
|
Otomatik olarak gönder
|
is_automatic_sending | boolean |
Belge oluşturulduktan sonra gönderilmeli mi? |
|
|
Anımsatıcı gönder
|
is_reminder_sending | boolean |
Otomatik anımsatıcılar gönderilmeli mi? |
|
|
Göndermeyi zamanla
|
is_scheduled_sending | boolean |
Göndermenin gelecekte gönderilmek üzere zamanlanması gerekir mi? |
|
|
Belgeyi imzala
|
is_signing | boolean |
Belge imza için gönderilmeli mi? |
|
|
El yazısı imza
|
is_signing_biometric | boolean |
El yazısı imza kullanma |
|
|
İmza aktarımına izin ver
|
is_signing_forward | boolean |
Alıcılar imza haklarını aktarabiliyor mu? |
|
|
Baş harflerle imzalayın
|
is_signing_initials | boolean |
Alıcının baş harflerini kullanarak belgeyi imzalama |
|
|
SMS gönder
|
is_sms_sending | boolean |
Belgenin metinle alıcı mobil cihazına gönderilmesi gerekir mi? |
|
|
Belge adı
|
name | True | string |
Belgenin adını girin |
|
Şirket adı
|
company_name | string |
Alıcının şirket adı |
|
|
Şirket numarası
|
company_number | string |
Alıcının şirket numarası |
|
|
E-posta
|
string |
Alıcının e-posta adresi |
||
|
İsim
|
first_name | string |
Alıcının adı |
|
|
Soyadı
|
last_name | string |
Alıcının soyadı |
|
|
Cep telefonu
|
mobile | string |
Cep telefonu uluslararası biçimde |
|
|
Uyarı
|
note | string |
Alıcı için ek not |
|
|
İmzalama sırası
|
order_num | integer |
İmzalama sırası etkinse |
|
|
Alıcı türü
|
role | string |
Belgedeki alıcı türü |
|
|
Şablon rolü
|
role_name | string |
Şablondaki rolün adı |
|
|
EID'i doğrulama
|
verify_eid | boolean |
EID kullanarak doğrulama |
|
|
EID türü
|
verify_eid_type | string |
Kişisel doğrulama için kullanılacak EID türü |
|
|
Soruyu etkinleştir
|
verify_qna | boolean |
Bir soru sorulması gerekir mi? |
|
|
Doğrulama yanıtı
|
verify_qna_answer | string |
Sorunun yanıtı |
|
|
Açık soru
|
verify_qna_open | boolean |
Belge açılmadan önce soru sorulmalıdır |
|
|
Doğrulama sorusu
|
verify_qna_question | string |
Doğrulama için sorulacak soru |
|
|
İmza sorusu
|
verify_qna_sign | boolean |
İmzalamadan önce bir soru sorulmalıdır |
|
|
SMS'i doğrulama
|
verify_sms | boolean |
Alıcıyı SMS ile doğrulama |
|
|
Açıkken SMS'i doğrulama
|
verify_sms_open | boolean |
Açıkken SMS'i doğrulama |
|
|
SMS ile doğrulama
|
verify_sms_sign | boolean |
SMS imzalamadan önce alıcıyı doğrulamalı mı? |
|
|
Gönderme tarihini zamanla
|
scheduled_sending_time | date-time |
Belgenin gönderilmesi gereken tarih ve saat |
|
|
Gönderen e-posta geçersiz kılma
|
sender_email | string |
Kimliği doğrulanmış kullanıcı dışında başka bir e-postadan gönderme |
|
|
Gönderen kullanıcı geçersiz kılma
|
sender_id | string |
Kimliği doğrulanmış dışında başka bir kullanıcıdan gönder |
|
|
Şablon Kimliği
|
template_id | string |
Gönderme için kullanılacak şablonu seçin |
|
|
Belge türü
|
type | string |
Belgenin türünü/kategorisini ayarlama |
|
|
Belge değeri
|
value | integer |
Anlaşma veya belgenin değeri |
|
|
Video Kimliği
|
video_id | string |
Gönderme için kullanılacak videoyu seçin |
Döndürülenler
Belge, bir kullanıcı tarafından oluşturulan bir veya birden çok alıcıya gönderilecek bir veya birden çok karşıya yüklenen dosyadır.
- Belge
- Document
Belgeleri listeleme
Kullanılabilir belgelerin listesini alma
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Durumdaki listeyi filtrele
|
filter | string |
Durumdaki listeyi filtrele |
|
|
Sonuçları sıralama
|
sort_by | string |
Sonuçları sıralama |
|
|
Sonuçların sıralama düzeni
|
sort_order | string |
Sonuçların sıralama düzeni |
|
|
Ekip üyelerinden belgeleri ekleme
|
showteam | boolean |
Ekip üyelerinden belgeleri ekleme |
|
|
Varlıktan tüm belgeleri dahil et
|
showall | boolean |
Varlıktan tüm belgeleri dahil et |
|
|
Dış Kimlik
|
external_id | string |
Dış kimlik, GetAccept dışındaki bir sistemden benzersiz kayıt tanımlayıcısı içerebilen özel bir alandır |
|
|
Ofset baskı
|
offset | number |
Listeyi x kaydından sınıra kadar başlat |
|
|
Sınır
|
limit | number |
Listelenecek kayıt sayısı |
Döndürülenler
Belge listesi
- Eşya
- Documents
Belgenin süre sonunu güncelleştirme
Belgenin son kullanma tarihini ve saatini güncelleştirmek için bu yöntemi kullanın.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Belge Kimliği
|
documentId | True | string |
Belge Kimliği |
|
Son kullanma tarihi
|
expiration_date | date-time |
Belgenin süresinin dolması gereken tarih ve saat (UTC) |
|
|
Bildirim gönder
|
send_notification | boolean |
Güncelleştirmeyle ilgili bir bildirim alıcılara gönderilmeli mi? |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Statü
|
status | integer |
Güncelleştirmenin durumu |
Belgeyi indirme
Belge dosyası her zaman indirilebilir, ancak büyük olasılıkla durumu İmzalı olduğunda indirmek istersiniz.
İndirme url'si almayı veya ikili dosyayı almayı seçebilirsiniz.
İndirme URL'sine bir istek yapıldıktan 10 dakika sonra erişilebilir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Belge Kimliği
|
documentId | True | string |
Belge Kimliği |
|
İkili dosyayı doğrudan döndürme
|
direct | string |
İkili dosyayı doğrudan döndürme |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
document_url
|
document_url | string | |
|
file
|
file | string |
Eki karşıya yükleme
Gönderdiğiniz belgelere eklemek için ek dosyalarını karşıya yükleyebilirsiniz. Başarılı istek attachment_id döndürür. Belgeye ek atamak için attachment_id kullanın.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Dosya içeriği
|
file_content | string |
Dosyayı base64 kodlanmış olarak gönderin. Base64 kodlama dosyalarının dosya boyutunu yaklaşık 30% artıracağını unutmayın |
|
|
Dosya adı
|
file_name | string |
Uzantılı belgenin dosya adı. Bu, farklı dosya türlerini dönüştürmek için yararlı olacaktır. |
|
|
Dosya URL'si
|
file_url | string |
Belge dosyasının URL'si. Dosyanın herhangi bir yetkilendirme olmadan indirilebilmesi gerekir |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Dosya adı
|
filename | string |
Ekin dosya adı |
|
Ek Kimliği
|
id | string |
Belge oluştururken attachment_id kullanılacak karşıya yüklenen ekin kimliği |
|
Ek başlığı
|
title | string |
Ekin başlığı |
|
Ek türü
|
type | string |
Ekin türü |
Ekleri listeleme
Kullanılabilir eklerin listesini alın. Yeni bir belge kullanarak GetAccept'e yeni ekler ekleyebilirsiniz.
Döndürülenler
Ek listesi
- Attachments
- Attachments
İlgili kişi oluştur
Bu, geçerli varlık için veritabanında yeni bir kişi oluşturur
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Şirket Adı
|
company_name | string |
İlişkili şirket adı |
|
|
Şirket Numarası
|
company_number | string |
İlişkili şirket numarası |
|
|
E-posta
|
string |
Kişinin e-posta adresi |
||
|
İsim
|
first_name | string |
Kişinin adı |
|
|
Adı ve soyadı
|
fullname | string |
Ad/soyadı yerine tam ad belirtmek için kullanın |
|
|
Soyadı
|
last_name | string |
Kişinin soyadı |
|
|
Cep telefonu
|
mobile | string |
Uluslararası biçimde cep telefonu numarası |
|
|
Uyarı
|
note | string |
İlgili kişi için isteğe bağlı dahili not |
|
|
Telefon
|
phone | string |
Uluslararası biçimde telefon numarası |
|
|
Başlık
|
title | string |
Kişinin başlığı, örn. CEO, Satış yöneticisi |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kişi Kimliği
|
contact_id | string |
Oluşturulan kişinin kimliği |
Kişileri listeleme
Geçerli varlık için kullanılabilir kişinin listesini alın. Alıcı olarak eklenen tüm kişiler kişi olarak kaydedilir ve daha sonra bu varlıkta kullanılabilir.
Döndürülenler
Kişi listesi
- İrtibatlar
- Contacts
Kullanıcı ayrıntılarını alma
Bu çağrı, tek bir kullanıcının ayrıntılarını döndürür. User-id me kullanarak geçerli kimliği doğrulanmış kullanıcının ayrıntılarını ve kullanılabilir varlıklarını alma
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Kullanıcı kimliği
|
userId | True | string |
Kullanıcı kimliği |
Döndürülenler
Bir kullanıcı, e-posta adresiyle tanımlanır ve bir veya birden çok varlık ile bağlantılıdır.
Kullanıcı Rolleri
Yönetici
- Tüm belgeleri görüntüleme
- Tüm belgeleri düzenle
- Varlık ayarlarını, bilgilerini ve faturalamayı değiştirme
- Varlığa yeni kullanıcılar ekleme
- Varlık rolleri atama
Müdür:
- Ekip belgelerini görüntüleme
- Tüm belgeleri düzenle
- Varlığa yeni kullanıcılar ekleme
Varlık
Varlık en üst düğümdür ve tüm kullanıcılar ve ilgili belgeler bir varlığa bağlanır. Varlık genellikle büyük bir kuruluştaki bir şirket, ülke veya departmanla aynıdır.
- User
- User
Kullanıcı oluşturma
Bu, geçerli varlık için veritabanında yeni bir kişi oluşturur
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
company_name
|
company_name | string |
İlişkili şirket adı |
|
|
company_number
|
company_number | string |
İlişkili şirket numarası |
|
|
e-posta
|
string |
Kişinin e-posta adresi |
||
|
first_name
|
first_name | string |
Kişinin adı |
|
|
tam ad
|
fullname | string |
Ad/soyadı yerine tam ad belirtmek için kullanın |
|
|
last_name
|
last_name | string |
Kişinin soyadı |
|
|
mobile
|
mobile | string |
Uluslararası biçimde cep telefonu numarası |
|
|
not
|
note | string |
İlgili kişi için isteğe bağlı dahili not |
|
|
phone
|
phone | string |
Uluslararası biçimde telefon numarası |
|
|
title
|
title | string |
Kişinin başlığı, örn. CEO, Satış yöneticisi |
Döndürülenler
Bir kullanıcı, e-posta adresiyle tanımlanır ve bir veya birden çok varlık ile bağlantılıdır.
Kullanıcı Rolleri
Yönetici
- Tüm belgeleri görüntüleme
- Tüm belgeleri düzenle
- Varlık ayarlarını, bilgilerini ve faturalamayı değiştirme
- Varlığa yeni kullanıcılar ekleme
- Varlık rolleri atama
Müdür:
- Ekip belgelerini görüntüleme
- Tüm belgeleri düzenle
- Varlığa yeni kullanıcılar ekleme
Varlık
Varlık en üst düğümdür ve tüm kullanıcılar ve ilgili belgeler bir varlığa bağlanır. Varlık genellikle büyük bir kuruluştaki bir şirket, ülke veya departmanla aynıdır.
- User
- User
Kullanıcıları listeleme
Geçerli kimliği doğrulanmış varlık için etkin kullanıcıların listesini getirme
Döndürülenler
Kullanıcı listesi
- Users
- Users
Liste şablonları
Kullanılabilir belge şablonlarının listesini alın. GetAccept'teki Templates-bölümünün altına yeni şablonlar ekleyebilirsiniz.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Tümünü göster
|
showall | string |
Varlık için tüm şablonları göster |
|
|
Klasör Kimliği
|
folder_id | string |
Şablonları belirli bir klasörde gösterme |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
templates
|
templates | array of object | |
|
tags
|
templates.tags | string | |
|
oluşturulma_tarihi
|
templates.created_at | string | |
|
external_editor_type
|
templates.external_editor_type | string | |
|
field_count
|
templates.field_count | integer | |
|
kimlik
|
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 |
Var olan belgeyi gönder
GetAccept aracılığıyla bir belge gönderdiğinizde, her biri benzersiz, güvenli bir bağlantı içeren bir e-postayı tüm alıcılara göndeririz. Bu API çağrısı, belge gönderme eylemini tetikler ve yalnızca document_status = taslak içeren belgeler üzerinde gerçekleştirilebilir. Belge, oluşturulduğu sırada sağladığınız alıcılara gönderilir.
Belge otomatik imza seçeneği kullanılarak oluşturulduysa, göndermeden önce kimliği doğrulanmış veya belirtilen kullanıcı tarafından da otomatik olarak imzalanır.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Belge Kimliği
|
documentId | True | string |
Belge Kimliği |
|
sender_email
|
sender_email |
Belgeyi kendi kendine imzalamak için kullanılacak e-posta adresine göre gönderen kullanıcıyı/sahibini belirtmek için bunu kullanın. |
||
|
sender_id
|
sender_id | string |
Belgeyi kendi kendine imzalamak için kullanılacak kimliğine göre gönderen kullanıcıyı/sahibini belirtmek için bunu kullanın. |
Döndürülenler
Belge, bir kullanıcı tarafından oluşturulan bir veya birden çok alıcıya gönderilecek bir veya birden çok karşıya yüklenen dosyadır.
- Belge
- Document
Video yükleme
Gönderdiğiniz belgelere eklemek için ek dosyalarını karşıya yükleyebilirsiniz. Başarılı istek attachment_id döndürür. Belgeye ek atamak için attachment_id kullanın.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Dosya içeriği
|
file_content | string |
Dosyayı base64 kodlanmış olarak gönderin. Base64 kodlama dosyalarının dosya boyutunu yaklaşık 30% artıracağını unutmayın |
|
|
Dosya adı
|
file_name | string |
Uzantılı belgenin dosya adı. Bu, farklı dosya türlerini dönüştürmek için yararlı olacaktır. |
|
|
Dosya URL'si
|
file_url | string |
Belge dosyasının URL'si. Dosyanın herhangi bir yetkilendirme olmadan indirilebilmesi gerekir |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Dosya durumu
|
file_status | string |
Videonun durumu |
|
Dosya adı
|
filename | string |
Videonun dosya adı |
|
İş Kimliği
|
job_id | string |
Videoyu dönüştüren ve sıkıştıran işleme işinin kimliği. /video/job/<ID> kullanarak iş durumu güncelleştirmelerini yoklama. |
|
Video Kimliği
|
video_id | string |
Belge oluştururken video_id kullanılacak karşıya yüklenen videonun kimliği |
Videoları listeleme
Varlıkta kullanılabilir videoların listesini alın. Mobil uygulamaya veya GetAccept içine yeni videolar ekleyebilirsiniz.
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
videos
|
videos | array of object | |
|
düzenlenebilir
|
videos.editable | boolean | |
|
Yayımlanmış
|
videos.published | boolean | |
|
Kaydedilmiş
|
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 |
Şablon alanlarını alma
Belirli bir şablon için alanların listesini alma.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Şablon Kimliği
|
templateId | True | string |
Şablon Kimliği |
Döndürülenler
Alan listesi
- Fields
- Fields
Şablon fiyatlandırma tablolarını alma
Belirli bir şablon için fiyatlandırma tablosu öğelerinin listesini alın.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Şablon Kimliği
|
templateId | True | string |
Şablon Kimliği |
Döndürülenler
Fiyatlandırma Tabloları
- Pricing
- PricingTables
Şablon rollerini alma
Belirli bir şablon için rollerin listesini alma.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Şablon Kimliği
|
templateId | True | string |
Şablon Kimliği |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
roles
|
roles | array of object | |
|
e-posta
|
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 |
Tetikleyiciler
| Belge gözden geçirildiğinde |
Belge alıcılardan herhangi biri tarafından gözden geçirildiğinde tetikler |
| Belge imzalandığında |
Belge tüm imzalama tarafları tarafından imzalandığında tetikler |
| Belge olaylarına abone olma |
Bu çağrı yeni bir abonelik oluşturur. Yanıt, REST kanca standartlarına göre tek bir nesne için bile bir diziye sarmalanır.
|
| Belge reddedildiğinde |
Belge alıcılardan herhangi biri tarafından reddedildiğinde tetikler |
Belge gözden geçirildiğinde
Belge alıcılardan herhangi biri tarafından gözden geçirildiğinde tetikler
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Tüm varlık kullanıcıları
|
global | boolean |
Web kancasının tüm varlık kullanıcıları için olayları yakalaması gerekiyorsa. |
|
|
Hata e-postası
|
notification_email | string |
Olay başarısız olursa, gönderen yerine bu e-postaya bir bildirim gönderin |
|
|
Yük
|
payload | string |
Gönderiye ek yük verileri |
Döndürülenler
Web kancası yükü
- Webhook
- Webhook
Belge imzalandığında
Belge tüm imzalama tarafları tarafından imzalandığında tetikler
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Tüm varlık kullanıcıları
|
global | boolean |
Web kancasının tüm varlık kullanıcıları için olayları yakalaması gerekiyorsa. |
|
|
Hata e-postası
|
notification_email | string |
Olay başarısız olursa, gönderen yerine bu e-postaya bir bildirim gönderin |
|
|
Yük
|
payload | string |
Gönderiye ek yük verileri |
Döndürülenler
Web kancası yükü
- Webhook
- Webhook
Belge olaylarına abone olma
Bu çağrı yeni bir abonelik oluşturur. Yanıt, REST kanca standartlarına göre tek bir nesne için bile bir diziye sarmalanır.
Events
-
document.created- Belge oluşturuldu -
document.sent- Belge gönderildi -
document.viewed- Belge gönderildi -
document.signed- Belge imzalandı -
document.approved- Belge onaylandı -
document.expired- Belgenin süresi doldu -
document.rejected- Belge reddedildi -
document.downloaded- Belge indirildi -
document.printed- Belge yazdırıldı -
document.forwarded- Belge iletildi -
document.partially_signed- Belge kısmen imzalanmış -
document.commented- Belge açıklamalı -
document.hardbounced- Belge sabit olarak atılmış -
document.imported- Belge içeri aktarıldı
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Olayı seçin
|
event | True | string |
Olay tetikleyicisi |
|
Tüm varlık kullanıcıları
|
global | boolean |
Web kancasının tüm varlık kullanıcıları için olayları yakalaması gerekiyorsa. |
|
|
Hata e-postası
|
notification_email | string |
Olay başarısız olursa, gönderen yerine bu e-postaya bir bildirim gönderin |
|
|
Yük
|
payload | string |
Gönderiye ek yük verileri |
Döndürülenler
Web kancası yükü
- Webhook
- Webhook
Belge reddedildiğinde
Belge alıcılardan herhangi biri tarafından reddedildiğinde tetikler
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Tüm varlık kullanıcıları
|
global | boolean |
Web kancasının tüm varlık kullanıcıları için olayları yakalaması gerekiyorsa. |
|
|
Hata e-postası
|
notification_email | string |
Olay başarısız olursa, gönderen yerine bu e-postaya bir bildirim gönderin |
|
|
Yük
|
payload | string |
Gönderiye ek yük verileri |
Döndürülenler
Web kancası yükü
- Webhook
- Webhook
Tanımlar
Attachment
Belge eki
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Erişim Alıcıları
|
access_recipient_names | array of string |
Eke erişimi olan alıcılar |
|
Description
|
attachment_description | string |
Ekin açıklaması |
|
URL'yi indirme
|
attachment_download_url | string |
Eki indirme URL'si |
|
Dosya Uzantısı
|
attachment_extension | string |
Ekin dosya uzantısı |
|
Filename
|
attachment_filename | string |
Ekin dosya adı |
|
Kimlik
|
attachment_id | string |
Ekin kimliği |
|
Önizleme URL'si
|
attachment_preview_url | string |
Eki önizlemek için iç URL |
|
Başlık
|
attachment_title | string |
Ekin başlığı |
|
Türü
|
attachment_type | string |
Ekin türü |
|
URL
|
attachment_url | string |
Ekin url'si |
|
Son Görünüm
|
last_attachment_view | string |
Ekin en son görüntülendiği tarih ve saat |
|
Kısıtlı erişim
|
restrict_access | boolean |
Ekin erişimi kısıtlandı |
Attachments
Ek listesi
| Name | Yol | Tür | Description |
|---|---|---|---|
|
attachments
|
attachments | array of Attachment |
İletişim
Her benzersiz e-posta adresi (veya cep telefonu numarası) kişi olarak tanımlanır.
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Şirket Kimliği
|
company_id | string |
Şirket Kimliği |
|
Şirket logosu
|
company_logo_url | string |
Şirket logosu |
|
Şirket adı
|
company_name | string |
İlgili kişinin şirket adı |
|
Şirket numarası
|
company_number | string |
İlgili kişinin şirket numarası |
|
Kişi Kimliği
|
contact_id | string |
Kişi Kimliği |
|
Oluşturuldu
|
created_at | string |
Kişinin oluşturulma tarihi |
|
Documents
|
document_count | number |
Kişi için belge sayısı |
|
İlgili kişinin e-posta adresi
|
string |
Oluşturulan belgenin adı |
|
|
İsim
|
first_name | string |
Kişinin adı |
|
Adı ve soyadı
|
fullname | string |
Kişinin tam adı |
|
Gender
|
gender | string |
Alıcının cinsiyeti |
|
Soyadı
|
last_name | string |
Kişinin soyadı |
|
Cep telefonu
|
mobile | string |
Kişinin cep telefonu numarası |
|
Uyarı
|
note | string |
Kişinin notları |
|
Başparmak URL'si
|
thumb_url | string |
Kişinin Başparmak URL'si |
|
Başlık
|
title | string |
Kişinin başlığı |
İrtibatlar
Kişi listesi
| Name | Yol | Tür | Description |
|---|---|---|---|
|
contacts
|
contacts | array of Contact |
Belge
Belge, bir kullanıcı tarafından oluşturulan bir veya birden çok alıcıya gönderilecek bir veya birden çok karşıya yüklenen dosyadır.
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Etiketler
|
tags | string |
Belge etiketleri |
|
Otomatik sohbet metni
|
auto_comment_text | string |
Otomatik sohbet metni |
|
Şirket Adı
|
company_name | string |
Şirket Adı |
|
Oluşturma saati:
|
created_at | string |
Belge oluşturulduğunda |
|
URL'yi indirme
|
download_url | string |
İmzalı belgeyi indirme URL'si |
|
E-posta iletisi
|
email_send_message | string |
E-posta iletisi gönderme |
|
E-posta Konusu
|
email_send_subject | string |
E-posta konu metni |
|
Son kullanma tarihi
|
expiration_date | string |
Belge son kullanma tarihi |
|
Dış İstemci Kimliği
|
external_client_id | string | |
|
Dış Düzenleyici Kimliği
|
external_editor_id | string |
Dış düzenleyicideki kimlik |
|
Dış Düzenleyici Türü
|
external_editor_type | string | |
|
Dış Kimlik
|
external_id | string | |
|
Alan sayısı
|
field_count | integer |
Belgedeki alan sayısı |
|
Kimlik
|
id | string | |
|
Otomatik açıklama
|
is_auto_comment | boolean |
Otomatik sohbet açıklaması etkinleştirildiyse |
|
Otomatik Açıklama E-postası
|
is_auto_comment_email | boolean |
Otomatik sohbet e-postası etkinse |
|
Alıcıyı Tanımla
|
is_identify_recipient | boolean |
Belgenin etkin alıcıyı tanımlaması varsa |
|
Özeldir
|
is_private | boolean |
Belge özelse |
|
Anımsatıcı gönder
|
is_reminder_sending | boolean |
Otomatik anımsatıcılar etkinse |
|
Zamanlanmış gönderme
|
is_scheduled_sending | boolean |
Belge gönderme zamanlanmışsa |
|
Otomatik imzalama
|
is_selfsign | boolean |
Belge gönderen tarafından otomatik olarak imzalanmışsa |
|
İmzalı
|
is_signed | boolean |
Belge imzalanmışsa |
|
İmzalanabilir belge
|
is_signing | boolean |
Belge imzalanabilirse |
|
El yazısı imza
|
is_signing_biometric | boolean |
El yazısı imza etkinse |
|
İmza aktarımına izin ver
|
is_signing_forward | boolean |
İmzalama haklarının aktarımı etkinleştirildiyse |
|
İmza sırası
|
is_signing_order | boolean |
Alıcı imzalama siparişi etkinleştirildiyse |
|
Video var
|
is_video | boolean |
Belgede giriş videosu varsa |
|
İsim
|
name | string |
Belgenin adı |
|
Üst Kimlik
|
parent_id | string |
Önceki belge sürümünün kimliği |
|
Önizleme URL'si
|
preview_url | string |
Belgenin iç önizlemesine bağlantı |
|
recipients
|
recipients | array of Recipient | |
|
Zamanlanan gönderme zamanı
|
scheduled_sending_time | string |
Belgenin gönderilmek üzere zamanlandığı zaman |
|
Gönderme tarihi
|
send_date | string |
Belge gönderme tarihi |
|
Gönderen e-postası
|
sender_email | string |
Gönderen kullanıcının e-posta adresi |
|
Gönderen adı
|
sender_name | string |
Gönderen kullanıcının adı |
|
Gönderen başparmak URL'si
|
sender_thumb_url | string |
Gönderen kullanıcının başparmak resmi |
|
İmza tarihi
|
sign_date | string |
Belge imzalama tarihi |
|
Statü
|
status | string |
Belgenin geçerli durumu |
|
Başparmak URL'si
|
thumb_url | string |
Belgenin başparmak resmi |
|
Türü
|
type | string |
Belge türü |
|
Benzersiz Kimlik
|
unique_id | integer |
Belgenin benzersiz kimliği |
|
Kullanıcı kimliği
|
user_id | string |
Gönderen kullanıcının kimliği |
|
Değer
|
value | integer |
Belgenin değeri |
Documents
Belge listesi
| Name | Yol | Tür | Description |
|---|---|---|---|
|
tags
|
tags | string | |
|
company_name
|
company_name | string | |
|
oluşturulma_tarihi
|
created_at | string | |
|
expiration_date
|
expiration_date | string | |
|
kimlik
|
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 | |
|
statü
|
status | string | |
|
type
|
type | string | |
|
value
|
value | integer |
EditorField
Düzenleyici Alanı ayrıntıları
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kimlik
|
id | string |
Kimlik |
|
Etiket
|
input_settings.label | string |
Etiket |
|
Options
|
input_settings.options | array of string |
Options |
|
Gerekli
|
input_settings.required | boolean |
Gerekli |
|
Türü
|
input_settings.type | string |
Türü |
|
Alıcı Kimliği
|
recipient_id | string |
Alıcı Kimliği |
|
Türü
|
type | string |
Türü |
|
Kullanıcı kimliği
|
user_id | string |
Kullanıcı kimliği |
Veri Alanı
Alan ayrıntıları
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Şirket Adı
|
company_name | string |
Şirket Adı |
|
Şirket Numarası
|
company_number | string |
Şirket Numarası |
|
Alan Kimliği
|
field_id | string |
Alan Kimliği |
|
Etiket
|
field_label | string |
Etiket |
|
Options
|
field_options | array of object |
Options |
|
Değer
|
field_options.value | string | |
|
Türü
|
field_type | string |
Türü |
|
Değer
|
field_value | string |
Değer |
|
is_collectable
|
is_collectable | boolean |
Alan topleniyor |
|
is_editable
|
is_editable | boolean |
Düzenlenebilir alan |
|
is_required
|
is_required | boolean |
Gerekli alan |
|
Sayfa Kimliği
|
page_id | string |
Sayfa Kimliği |
|
Alıcı Kimliği
|
recipient_id | string |
Alıcı Kimliği |
|
Alıcı Adı
|
recipient_name | string |
Alıcı Adı |
|
Rol Adı
|
role_name | string |
Rol Adı |
Fields
Alan listesi
| Name | Yol | Tür | Description |
|---|---|---|---|
|
editor_fields
|
editor_fields | array of EditorField | |
|
Alanları
|
fields | array of Field |
PricingColumn
Fiyatlandırma Tablosu Sütunu
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kimlik
|
column_id | string |
Kimlik |
|
Görüntü adı
|
display_name | string |
Görüntü adı |
|
Etkinleştirildi
|
enabled | boolean |
Etkinleştirildi |
|
İsim
|
name | string |
İsim |
PricingSection
Fiyatlandırma Tablosu Bölümü
| Name | Yol | Tür | Description |
|---|---|---|---|
|
columns
|
columns | array of PricingColumn | |
|
Görüntü adı
|
display_name | string |
Görüntü adı |
|
İsim
|
name | string |
İsim |
|
Kimlik
|
section_id | string |
Kimlik |
PricingTable
Fiyatlandırma Tablosu
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Para birimi
|
currency_settings.currency | string |
Para birimi |
|
Locale
|
currency_settings.locale | string |
Locale |
|
Önceden hesaplanan toplamlar
|
pre_calculated | boolean |
Önceden hesaplanan toplamlar |
|
Bölüm
|
sections | array of PricingSection | |
|
Kimlik
|
table_id | string |
Tablo Kimliği |
PricingTables
Fiyatlandırma Tabloları
| Name | Yol | Tür | Description |
|---|---|---|---|
|
pricing_tables
|
pricing_tables | array of PricingTable |
Recipient
Belgeye bağlı her benzersiz e-posta adresi (veya cep telefonu numarası) alıcıdır.
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Şirket adı
|
company_name | string |
Alıcının şirket adı |
|
Şirket numarası
|
company_number | string |
Alıcının şirket numarası |
|
Belge URL'si
|
document_url | string |
Alıcının görüntülemesi/imzalaması için benzersiz URL |
|
Alıcı e-postası
|
string |
Alıcının e-posta adresi |
|
|
İsim
|
first_name | string |
Alıcının adı |
|
Adı ve soyadı
|
fullname | string |
Alıcının tam adı |
|
Gender
|
gender | string |
Alıcının cinsiyeti |
|
Kimlik
|
id | string |
Alıcının kimliği |
|
Soyadı
|
last_name | string |
Alıcının soyadı |
|
Cep telefonu
|
mobile | string |
Alıcının cep telefonu numarası |
|
Uyarı
|
note | string |
Alıcıyı not edin |
|
İmzalama siparişi numarası
|
order_num | string |
Alıcının imzalama sırası |
|
Statü
|
status | string |
Alıcının durumu |
|
Başparmak URL'si
|
thumb_url | string |
Alıcının başparmak URL'si |
|
Başlık
|
title | string |
Alıcının başlığı |
Alıcı
Alıcı listesi
| Name | Yol | Tür | Description |
|---|---|---|---|
|
recipients
|
recipients | array of Recipient |
User
Bir kullanıcı, e-posta adresiyle tanımlanır ve bir veya birden çok varlık ile bağlantılıdır.
Kullanıcı Rolleri
Yönetici
- Tüm belgeleri görüntüleme
- Tüm belgeleri düzenle
- Varlık ayarlarını, bilgilerini ve faturalamayı değiştirme
- Varlığa yeni kullanıcılar ekleme
- Varlık rolleri atama
Müdür:
- Ekip belgelerini görüntüleme
- Tüm belgeleri düzenle
- Varlığa yeni kullanıcılar ekleme
Varlık
Varlık en üst düğümdür ve tüm kullanıcılar ve ilgili belgeler bir varlığa bağlanır. Varlık genellikle büyük bir kuruluştaki bir şirket, ülke veya departmanla aynıdır.
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Uygulama Modu
|
app_mode | string | |
|
disallow_create
|
disallow_create | boolean | |
|
E-posta
|
string |
Kullanıcının e-posta adresi |
|
|
Varlık Kimliği
|
entity_id | string | |
|
Varlık Adı
|
entity_name | string | |
|
İsim
|
first_name | string |
Kullanıcının adı |
|
Kimlik
|
id | string |
Kullanıcının kimliği |
|
Language
|
language | string | |
|
Soyadı
|
last_name | string |
Kullanıcının soyadı |
|
mobile
|
mobile | string |
Uluslararası biçimde cep telefonu numarası |
|
Uyarı
|
note | string |
Kullanıcı için isteğe bağlı iç not |
|
Telefon
|
phone | string |
Uluslararası biçimde telefon numarası |
|
Rol
|
role | string | |
|
Davet göndermeyi atla
|
skip_invitation | boolean | |
|
Statü
|
status | string | |
|
Ekip Kimliği
|
team_id | string | |
|
Başparmak URL'si
|
thumb_url | string | |
|
Timezone
|
timezone | string | |
|
Başlık
|
title | string |
Kullanıcının başlığı, örn. CEO, Satış yöneticisi |
Users
Kullanıcı listesi
| Name | Yol | Tür | Description |
|---|---|---|---|
|
users
|
users | array of object | |
|
E-posta
|
users.email | string | |
|
İlk İsim
|
users.first_name | string | |
|
Son Oturum Açma
|
users.last_login | string | |
|
Soyadı
|
users.last_name | string | |
|
Kullanıcı Adı
|
users.name | string | |
|
Rol
|
users.role | string | |
|
Statü
|
users.status | string | |
|
Ekip Adı
|
users.team_name | string | |
|
Kullanıcı kimliği
|
users.user_id | string |
Webhook
Web kancası yükü
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Özel Alanlar
|
custom_fields | object | |
|
Belge
|
document | Document |
Belge, bir kullanıcı tarafından oluşturulan bir veya birden çok alıcıya gönderilecek bir veya birden çok karşıya yüklenen dosyadır. |
|
Varlık özel etki alanı
|
entity.custom_domain | string |
Varlık için özel etki alanı ayarı |
|
Varsayılan e-posta iletisi
|
entity.email_send_message | string |
Varsayılan e-posta iletisi |
|
Varsayılan e-posta konusu
|
entity.email_send_subject | string |
Varsayılan e-posta konusu |
|
Varlık alt etki alanı
|
entity.sub_domain | string |
Varlık için alt etki alanı |
|
Olay adı
|
event | string | |
|
Olay eylemi
|
event_action | string | |
|
Olay türü
|
event_type | string | |
|
Recipient
|
recipient | Recipient |
Belgeye bağlı her benzersiz e-posta adresi (veya cep telefonu numarası) alıcıdır. |
|
Abonelik Kimliği
|
subscription_id | string |