Professional Documents
Culture Documents
TeamGramAPI v1 76
TeamGramAPI v1 76
TeamGramAPI v1 76
TEAMGRAMAPI
Doküman Sürümü 1.76
Doküman Sürüm Tablosu
API’ye duruma göre http GET/POST yöntemleriyle ulaşıp, requeste key/value şeklinde bilgi vererek ve
sonuçları JSON formatında alarak konuşabilirsiniz.
Doğrulama
TeamGram API’sine yapacağınız her çağrıda http Header’da “Basic Autorization” olarak API’yi
kullanacak kişinin (Veya API için özel açılmış kullanıcının) kullanıcı adı ve şifresini (Base64
username:password) göndermeniz gerekmektedir.
Entegrasyonlar
Bir kayıt oluştururken kendi veritabanıza ait bir Id'yi LogoID alanına kaydedebilirsiniz.
Aynı LogoID'ye ait 2 kayıt oluşturulmaya çalışıldığında API 404 hatası verecektir.
LogoID'ye sahip kayıtlar TeamGram arayüzünden değiştirilemez ve silinemez.
Fonksiyonlar
TeamGram API’sinde bir çok alan için kullanılır.
Konumları listeleme
Bu metod ile konumları girilen verilerin(şirket, kişiler gibi) verdiğiniz bilgiler doğrultusunda verileri
size listeler. Örnek: Konumunuzu ve o noktadan sonra kaç km olduğunu veriyorsunuz. Bu bilgiler
doğrultusunda o km içinde konumları bulunan veriler listelenir.
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/GetCustomerLocations
Request
latitude (String)
longitude (String)
distance_in_km (string): Verilen km çevresi içinde ki konumlar
entityTypes (Array of String): Hangi tiplerin gelmesini belirlemek. (“Party”) Şuanlık sadece
“Party” üzerinden işlem yapılmakta.
Response
Result (Array of Object)
o item: Verinin temel bilgileri
EntityId (Integer): Id’si
Name (String): Adı
ClassName (String): Tipi, örnek: “Party”
Own (Boolean): Sahibi
o LocationInfo: Konum bilgileri
EntityId (Integer): Id’si
Latitude (Double)
Longitude (Double)
InDate (DateTime)
distance_in_km (Double)
zoom (Integer)
Favori işlemi
Bu metod, verilen Id’ye sahip veriyi eğer favorisi ise favorilerimden çıkarır, değilse ekleme işlemini
yapar.
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/Favorite
Request
id (Integer): Favoriye eklenecek verinin Id’si
Response
success (Boolean): True ise işlem başarılıdır.
Şirketler
Aşağıdaki API işlemleri, TeamGram’da “şirketler” kısmıyla ilgilidir. Burada bilgilere erişim için
kullanılan kullanıcı adının ve bulunduğu departmanın güvenlik ayarları geçerlidir.
Listeleme
Bu metod, şirketleri sayfa sayfa almaya yarar ancak şirketlerin tüm detayları gelmez. Vereceği veriler
için bazı filtre özellikleri mevcuttur.
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/CompanyList
Request
page (Integer: default:1)
pagesize (Integer: default:20)
fid (integer?: default:null)
o 0: Tüm şirketler
o N: Bu kullanıcı için tanımlanmış bir filtrenin id’si (TeamGram arayüzünden
tanımlanabilir)
Response
companyCount (Integer): Toplam şirket sayısı
page (Integer): Bulunulan sayfa
pageSize (Integer): Sayfada bulunan toplam kayıt sayısı
CustomFields (Array of Object)
o Id (Integer)
o Name (String): Özel alan adı
o EntityType (String): “Party”
o Type (Integer)
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Required (Boolean)
o PropertiesPulldownStrings (String Array): Pulldown tipli alanların içeriği
o Order (Integer): Gösterilme sırası
Companies (Array of Object) : Şirket
o Id (Integer)
o Name (String): Şirket ismi
o ProfilePictureFileKey
o NotAvaliable (Boolean)
o IsFavorite (Boolean): Favori
Filters (Array of Object)
o Name (String)
o Id (Integer)
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/Companies/GetUpdated
Request
fromDate (DateTime)
o Tarih formatı iso8601: (YYYY-MM-DD) Örnek: ?fromDate=2016-11-30
page (Integer: default:1)
pagesize (Integer: default:20)
Response
count (Integer)
page (Integer)
pageSize (Integer)
companies (Array of Object) : Şirketler
Id (Integer)
Name (String): Şirket ismi
Description (String): Açıklama
Contactinfos (Array)
o ContactInfoType
Name (String): Şunlardan birisi olabilir:
Address
Email
Phone
Social
Web
SubType (String): Şunlardan birisi olabilir:
Address ise:
o Business
o Home
o Other
Email ise:
o Business
o Personal
o Other
Phone ise:
o Home
o Other
o Fax
o HomeFax
o DirectFax
o WorkMobile
Web ise:
o Website
Priority (Integer)
o Value
o SearchableValue (String)
o StateName (String) : Durum adı
o CityName (String)
o SpecialDate (DateTime?)
o ZipCode (String)
o ValuesOrder (Integer) : Değerlerin sırası
Tags (Array of String): Etiket isim listesi
CustomFieldDatas (Array): Özel alan veri listesi
o Id (Integer)
o CustomFieldId (Integer) : Özel alan Id’si
o IsRequired (Boolean)
o RelatedEntity: Firmanın müşterisi
Id (Integer)
Name (String) : Müşterinin adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Müşterinin tam adı
TaxNo (String)
TaxOffice (String)
o ScanCode (Boolean)
o ListValues (Array of String)
o UnFormettedDate (String) : Formatsız tarih
o UnFormattedNumber (String) : Formatsız rakam
o CustomFieldName (String) : Özel alan adı
o CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Value (String)
o Values (String)
Owner: Şirketin sahibi/yetkili kişisi
o Id (Integer)
o Name (String)
ReadersIdToString (Array of String) : Okuma izinleri
WritersIdToString (Array of String) : Yazma izinleri
EnteredDate (DateTime): Oluşturulduğu tarih
ModifiedDate (DateTime): Değiştirildiği tarih
LastActivityDate (DateTime): En son bu şirketle ilgili işlem yapılma tarihi
EnteredBy: Giren kişi
o Id (Integer)
o Name (String)
ModifiedBy: Değiştiren kişi
o Id (Integer)
o Name (String)
NotAvailable (Boolean)
DefaultDueDays (Integer?)
TaxNo (String)
TaxOffice (String)
LogoId (String): Bu kaydın varsa Logo programındaki kodu, yoksa null olarak döner.
URL
POST https://api.teamgram.com/[ŞİRKETİSMİ]/Companies/GetNew
Request
Id (Integer)
page (Integer: default:1)
pagesize (Integer: default:20)
Response
count (Integer)
page (Integer)
pageSize (Integer)
companies (Array of Object)
Id (Integer)
Name (String): Şirket ismi
Description (String): Açıklama
Contactinfos (Array)
o ContactInfoType
Name (String): Şunlardan birisi olabilir:
Address
Email
Phone
Social
Web
SubType (String): Şunlardan birisi olabilir:
Address ise:
o Business
o Home
o Other
Email ise:
o Business
o Personal
o Other
Phone ise:
o Home
o Other
o Fax
o HomeFax
o DirectFax
o WorkMobile
Web ise:
o Website
Priority (Integer)
o Value
o SearchableValue (String)
o StateName (String)
o CityName (String)
o SpecialDate (DateTime?)
o ZipCode (String)
o ValuesOrder (Integer)
IsFavorite (Boolean): Favori
GeoLocationInfos (Array of Object) : Şirketin konum bilgileri (Şuan tek bir konum
üzerinde çalışmakta)
o EntityType (String): “Party”
o Latitude (Double)
o Longitude (Double)
o Zoom (int)
InDate (DateTime)
Tags (Array of String): Etiket isim listesi
CustomFieldDatas (Array): Özel alan veri listesi
o Id (Integer)
o CustomFieldId (Integer) : Özel alan Id’si
o IsRequired (Boolean)
o RelatedEntity: Siparişin müşterisi
Id (Integer)
Name (String) : Müşterinin adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Müşterinin tam adı
TaxNo (String)
TaxOffice (String)
o ScanCode (Boolean)
o ListValues (Array of String)
o UnFormettedDate (String) : Formatsız tarih
o UnFormattedNumber (String) : Formatsız rakam
o CustomFieldName (String) : Özel alan adı
o CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Value (String)
o Values (String)
Owner: Şirketin sahibi/yetkili kişisi
o Id (Integer)
o Name (String)
ReadersIdToString (Array of String) : Okuma izinleri
WritersIdToString (Array of String) : Yazma izinleri
EnteredDate (DateTime): Oluşturulduğu tarih
ModifiedDate (DateTime): Değiştirildiği tarih
LastActivityDate (DateTime): En son bu şirketle ilgili işlem yapılma tarihi
EnteredBy: Giren kişi
o Id (Integer)
o Name (String)
ModifiedBy: Değiştiren kişi
o Id (Integer)
o Name (String)
NotAvailable (Boolean)
DefaultDueDays (Integer?)
TaxNo (String)
TaxOffice (String)
LogoId (String): Bu kaydın varsa Logo programındaki kodu, yoksa null olarak döner.
Detaylı Listeleme
Bu metod, şirketleri tüm detayları ile sayfa sayfa almaya yarar.
URL
POST https://api.teamgram.com/[ŞİRKETİSMİ]/Companies/GetAll
Request
page (Integer: default:1)
pagesize (Integer: default:20)
Response
count (Integer)
page (Integer)
pageSize (Integer)
companies (Array of Object)
Id (Integer)
Name (String): Şirket ismi
Description (String): Açıklama
Contactinfos (Array)
o ContactInfoType
Name (String): Şunlardan birisi olabilir:
Address
Email
Phone
Social
Web
SubType (String): Şunlardan birisi olabilir:
Address ise:
o Business
o Home
o Other
Email ise:
o Business
o Personal
o Other
Phone ise:
o Home
o Other
o Fax
o HomeFax
o DirectFax
o WorkMobile
Web ise:
o Website
Priority (Integer)
o Value
o SearchableValue (String)
o StateName (String)
o CityName (String)
o SpecialDate (DateTime?)
o ZipCode (String)
o ValuesOrder (Integer)
IsFavorite (Boolean): Favori
Tags (Array of String): Etiket isim listesi
GeoLocationInfos (Array of Object) : Şirketin konum bilgileri (Şuan tek bir konum
üzerinde çalışmakta)
o EntityType (String): “Party”
o Latitude (Double)
o Longitude (Double)
o Zoom (int)
o InDate (DateTime)
CustomFieldDatas (Array): Özel alan veri listesi
o Id (Integer)
o CustomFieldId (Integer) : Özel alan Id’si
o IsRequired (Boolean)
o RelatedEntity: Siparişin müşterisi
Id (Integer)
Name (String) : Müşterinin adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Müşterinin tam adı
TaxNo (String)
TaxOffice (String)
o ScanCode (Boolean)
o ListValues (Array of String)
o UnFormettedDate (String) : Formatsız tarih
o UnFormattedNumber (String) : Formatsız rakam
o CustomFieldName (String) : Özel alan adı
o CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Value (String)
o Values (String)
Owner: Şirketin sahibi/yetkili kişisi
o Id (Integer)
o Name (String)
ReadersIdToString (Array of String) : Okuma izinleri
WritersIdToString (Array of String) : Yazma izinleri
EnteredDate (DateTime): Oluşturulduğu tarih
ModifiedDate (DateTime): Değiştirildiği tarih
LastActivityDate (DateTime): En son bu şirketle ilgili işlem yapılma tarihi
EnteredBy: Giren kişi
o Id (Integer)
o Name (String)
ModifiedBy: Değiştiren kişi
o Id (Integer)
o Name (String)
NotAvailable (Boolean)
DefaultDueDays (Integer?)
TaxNo (String)
TaxOffice (String)
LogoId (String): Bu kaydın varsa Logo programındaki kodu, yoksa null olarak döner.
Oluşturma
Bu metod ile yeni bir şirket oluşturabilirsiniz.
URL
POST https://api.teamgram.com/[ŞİRKETİSMİ]/CreateCompany
Request
Name (String) : Firma ismi
ContactInfos
o EmailWork (String[]): E-posta.
o PhoneWork (String[]): İş telefonu.
o PhoneFax (String[]): Fax.
o Address (String[]): Adres.
o PhoneMobile (String[]): Cep telefonu.
o Website (String[]): Web sitesi adresi.
GeoLocationInfos (Array of Object) : Şirketin konum bilgileri (Şuan tek bir konum
üzerinde çalışmakta)
o EntityType (String): “Party”
o Latitude (Double)
o Longitude (Double)
o Zoom (int)
o InDate (DateTime)
Description (String): Açıklama
EmailWork (String): E-posta
Tags (String array): Etiket listesi
ReadersIdToString (Array of String) : Okuma izinleri
WritersIdToString (Array of String) : Yazma izinleri
CustomFieldDatas (Array): Özel alan veri listesi
o CustomFieldId (Integer) : Özel alan Id’si
o Value (String)
ProfilePhoto (HttpPostedFileBase .NET)
ClearProfilePhoto (Boolean)
ProfilePictures
o Small (String)
o Medium (String)
o Large (String)
o Original (String)
o SocialPicture (String)
Publish (Boolean)
ContactName (String)
ContactLastName (String)
DefaultDueDays (Integer?)
TaxNo (String)
TexOffice (String)
LogoId (String): Bu kayıdın varsa Logo programındaki kodu. Eğer bu kaydın Logoda
karşılığı yoksa bu değer gönderilmeyebilir yada null olarak gönderilebilir
Response
Result (Boolean)
Id (Integer): oluşan şirketin unique Id’si
Message (String)
MessageCode (Integer)
o NULL: No error
o 0: GeneralError
o 1: EntityLimitExceeded
o 2: MaxStorageExceeded
o 3: MaxFileSizeExceeded
o 4: MonthlyMaxFilesExceeded
o 5: CreateRestriction
o 6: RequiredDataMissing
Değiştirme
Bu metod ile unique Id’si belli bir şirketin içeriğini değiştirebilirsiniz.
URL
POST https://api.teamgram.com/[ŞİRKETİSMİ]/Companies/Edit
Request
Name (String) : Firma ismi
ContactInfos
o EmailWork (String[]): E-posta. Silmek için arrayi boş gönderin.
o PhoneWork (String[]): İş telefonu. Silmek için arrayi boş gönderin.
o PhoneFax (String[]): Fax. Silmek için arrayi boş gönderin.
o Address (String[]): Adres. Silmek için arrayi boş gönderin.
o PhoneMobile (String[]): Cep telefonu. Silmek için arrayi boş gönderin.
o Website (String[]): Web sitesi adresi. Silmek için arrayi boş gönderin.
GeoLocationInfos (Array of Object) : Şirketin konum bilgileri (Şuan tek bir konum
üzerinde çalışmakta)
o EntityType (String): “Party”
o Latitude (Double)
o Longitude (Double)
o Zoom (int)
o InDate (DateTime)
Description (String): Açıklama
Tags (String array): Etiket listesi
ReadersIdToString (Array of String) : Okuma izinleri
WritersIdToString (Array of String) : Yazma izinleri
CustomFieldDatas (Array): Özel alan veri listesi
o CustomFieldId (Integer) : Özel alan Id’si
o Value (String)
ProfilePhoto (HttpPostedFileBase .NET)
ClearProfilePhoto (Boolean)
ProfilePictures
o Small (String)
o Medium (String)
o Large (String)
o Original (String)
o SocialPicture (String)
Publish (Boolean) : Güncelleme zamanını güncelle
ContactName (String)
ContactLastName (String)
DefaultDueDays (Integer?) : Vade günleri
TaxNo (String)
TexOffice (String)
LogoId (String): LogoId (String): Bu kaydın varsa Logo programındaki kodu. Eğer bu kaydın
Logoda karşılığı yoksa bu değer gönderilmeyebilir ya da null olarak gönderilebilir. null
gönderildiğinde veya gönderilmediğinde bu alan yoksayılır. Bu alandaki değeri silmek için
ise -1 değeri gönderilebilir.
CanEditSharingRights (Boolean)
Owner : Firma sahibi
o Id (Integer)
o Displayname (String) : Adı
o ClassName (String) : Cinsi (Party, Individual etc.)
o TaxNo (String)
o TaxOffice (String)
CustomFields : (Array of Object)
o Id (Integer)
o Name (String) : Özel alan adı
o EntityType (String) : “Party”
o Type (Integer)
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Required (Boolean)
o PropertiesPulldownStrings (String Array) : Pulldown tipli alanların içeriği
Order (Integer) : Gösterilme sırası
NotAvailable (Boolean?)
Response
Result (Boolean)
Id (Integer)
Message (String)
MessageCode (Integer)
o NULL: No error
o 0: GeneralError
o 1: EntityLimitExceeded
o 2: MaxStorageExceeded
o 3: MaxFileSizeExceeded
o 4: MonthlyMaxFilesExceeded
o 5: CreateRestriction
o 6: RequiredDataMissing
Errors
404 – Company not found
404 – No access
Görme
Bu metod ile unique Id’si belli bir şirketin tüm detaylarını görebilirsiniz.
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/Company
Request
Id (Integer)
Response
Id (Integer)
Name (String): Şirket ismi
Description (String): Açıklama
Contactinfos (Array)
o ContactInfoType
Name (String): Şunlardan birisi olabilir:
Address
Email
Phone
Social
Web
SubType (String): Şunlardan birisi olabilir:
Address ise:
o Business
o Home
o Other
Email ise:
o Business
o Personal
o Other
Phone ise:
o Home
o Other
o Fax
o HomeFax
o DirectFax
o WorkMobile
Web ise:
o Website
Priority (Integer)
o Value
o SearchableValue (String)
o StateName (String)
o CityName (String)
o SpecialDate (DateTime?)
o ZipCode (String)
o ValuesOrder (Integer)
IsFavorite (Boolean): Favori
Tags (Array of String): Etiket isim listesi
GeoLocationInfos (Array of Object) : Şirketin konum bilgileri (Şuan tek bir konum üzerinde
çalışmakta)
o EntityType (String): “Party”
o Latitude (Double)
o Longitude (Double)
o Zoom (int)
o InDate (DateTime)
CustomFieldDatas (Array): Özel alan veri listesi
o Id (Integer)
o CustomFieldId (Integer) : Özel alan Id’si
o IsRequired (Boolean)
o RelatedEntity: Siparişin müşterisi
Id (Integer)
Name (String) : Müşterinin adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Müşterinin tam adı
TaxNo (String)
TaxOffice (String)
o ScanCode (Boolean)
o ListValues (Array of String)
o UnFormettedDate (String) : Formatsız tarih
o UnFormattedNumber (String) : Formatsız rakam
o CustomFieldName (String) : Özel alan adı
o CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Value (String)
o Values (String)
Owner: Şirketin sahibi/yetkili kişisi
o Id (Integer)
o Name (String)
ReadersIdToString (Array of String) : Okuma izinleri
WritersIdToString (Array of String) : Yazma izinleri
EnteredDate (DateTime): Oluşturulduğu tarih
ModifiedDate (DateTime): Değiştirildiği tarih
LastActivityDate (DateTime): En son bu şirketle ilgili işlem yapılma tarihi
EnteredBy: Giren kişi
o Id (Integer)
o Name (String)
ModifiedBy: Değiştiren kişi
o Id (Integer)
o Name (String)
NotAvailable (Boolean)
DefaultDueDays (Integer?)
TaxNo (String)
TaxOffice (String)
LogoId (String): Bu kaydın varsa Logo programındaki kodu, yoksa null olarak döner.
Errors
404 – Company not found
404 – No access
Silme
Bu metod ile şirketleri silebilirsiniz.
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/DeleteCompany
Request
Id (Integer)
Response
Result (Boolean)
Errors
404 – Company not found
404 – No access
Kişiler
Listeleme
Bu metod, kişileri sayfa sayfa almaya yarar ancak kişilerin tüm detayları gelmez. Vereceği veriler için
bazı filtre özellikleri mevcuttur.
URL
https://api.teamgram.com/[ŞİRKETİSMİ]/ContactList
Request
page (Integer: default:1)
pagesize (Integer: default:20)
fid (Integer: default:null)
o 0: Tüm kişiler
o N: Bu kullanıcı için tanımlanmış bir filtrenin Id’si (TeamGram arayüzünden
tanımlanabilir)
Response
contactCount (Integer): Toplam kişi sayısı
page (Integer): Bulunulan sayfa
pageSize (Integer): Sayfada bulunan toplam kayıt sayısı
CustomFields (Array of Object)
o Id (Integer)
o Name (String): Özel alan adı
o EntityType (String): “Party”
o Type (Integer)
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Required (Boolean)
o PropertiesPulldownStrings (String Array): Pulldown tipli alanların içeriği
o Order (Integer): Gösterilme sırası
Contacts (Array of Object)
o Id (Integer)
o Name (String): Kişi adı soyadı
o Position (String): Kişinin titri
o ProfilePictureFileKey (String)
o NotEmployed (Boolean)
o CompanyName (String) : Firma adı
o CompanyId (Integer) : Firma Id’si
o IsFavorite (Boolean): Favori
Filters (Array of Object)
o Name (String)
o Id (Integer)
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/Contacts/GetUpdated
Request
fromDate (DateTime)
o Tarih formatı iso8601: (YYYY-MM-DD) Örnek: ?fromDate=2016-11-30
page (Integer: default:1)
pagesize (Integer: default:20)
Response
count (Integer)
page (Integer)
pageSize (Integer)
contacts (Array of Object)
Id (Integer)
Name (String): Kişi isim ve soyadı
Position (String): Kişinin titri
CompanyName (String): Şirketinin ismi
CompanyId (Integer): Şirketinin Id’si
Gender (String)
Description (String): Açıklama
Contactinfos (Array)
o ContactInfoType
Name (String): Şunlardan birisi olabilir:
Address
Email
Phone
Social
Web
SubType (String): Şunlardan birisi olabilir:
Address ise:
o Business
o Home
o Other
Email ise:
o Business
o Personal
o Other
Phone ise:
o Home
o Other
o Fax
o HomeFax
o DirectFax
o WorkMobile
Web ise:
o Website
Priority (Integer)
o Value
o SearchableValue (String)
o StateName (String)
o CityName (String)
o SpecialDate (DateTime?)
o ZipCode (String)
o ValuesOrder (Integer)
NotEmployed (Boolean): Hala çalışıp çalışmadığı
Tags (Array of String): Etiket isim listesi
IsOwn (Boolean)
CustomFieldDatas (Array): Özel alan veri listesi
o Id (Integer)
o CustomFieldId (Integer) : Özel alan Id’si
o IsRequired (Boolean)
o RelatedEntity: Siparişin müşterisi
Id (Integer)
Name (String) : Müşterinin adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Müşterinin tam adı
TaxNo (String)
TaxOffice (String)
o ScanCode (Boolean)
o ListValues (Array of String)
o UnFormettedDate (String) : Formatsız tarih
o UnFormattedNumber (String) : Formatsız rakam
o CustomFieldName (String) : Özel alan adı
o CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Value (String)
o Values (String)
Owner: Şirketin sahibi/yetkili kişisi
o Id (Integer)
o Name (String)
EnteredDate (DateTime): Oluşturulduğu tarih
ModifiedDate (DateTime): Değiştirildiği tarih
LastActivityDate (DateTime): En son bu kişiyle ilgili işlem yapılma tarihi
EnteredBy: Giren kişi
o Id (Integer)
o Name (String)
ModifiedBy: Değiştiren kişi
o Id (Integer)
o Name (String)
LogoId (String): Bu kaydın varsa Logo programındaki kodu, yoksa null olarak döner.
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/Contacts/GetNew
Request
Id (Integer)
page (Integer: default:1)
pagesize (Integer: default:20)
Response
count (Integer)
page (Integer)
pageSize (Integer)
contacts (Array of Object)
Id (Integer)
Name (String): Kişi isim ve soyadı
Position (String): Kişinin titri
CompanyName (String): Şirketinin ismi
CompanyId (Integer): Şirketinin Id’si
Gender (String)
Description (String): Açıklama
Contactinfos (Array)
o ContactInfoType
Name (String): Şunlardan birisi olabilir:
Address
Email
Phone
Social
Web
SubType (String): Şunlardan birisi olabilir:
Address ise:
o Business
o Home
o Other
Email ise:
o Business
o Personal
o Other
Phone ise:
o Home
o Other
o Fax
o HomeFax
o DirectFax
o WorkMobile
Web ise:
o Website
Priority (Integer)
o Value
o SearchableValue (String)
o StateName (String)
o CityName (String)
o SpecialDate (DateTime?)
o ZipCode (String)
o ValuesOrder (Integer)
IsFavorite (Boolean): Favori
NotEmployed (Boolean): Hala çalışıp çalışmadığı
Tags (Array of String): Etiket isim listesi
IsOwn (Boolean)
CustomFieldDatas (Array): Özel alan veri listesi
o Id (Integer)
o CustomFieldId (Integer) : Özel alan Id’si
o IsRequired (Boolean)
o RelatedEntity: Siparişin müşterisi
Id (Integer)
Name (String) : Müşterinin adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Müşterinin tam adı
TaxNo (String)
TaxOffice (String)
o ScanCode (Boolean)
o ListValues (Array of String)
o UnFormettedDate (String) : Formatsız tarih
o UnFormattedNumber (String) : Formatsız rakam
o CustomFieldName (String) : Özel alan adı
o CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Value (String)
o Values (String)
Owner: Şirketin sahibi/yetkili kişisi
o Id (Integer)
o Name (String)
EnteredDate (DateTime): Oluşturulduğu tarih
ModifiedDate (DateTime): Değiştirildiği tarih
LastActivityDate (DateTime): En son bu kişiyle ilgili işlem yapılma tarihi
EnteredBy: Giren kişi
o Id (Integer)
o Name (String)
ModifiedBy: Değiştiren kişi
o Id (Integer)
o Name (String)
LogoId (String): Bu kaydın varsa Logo programındaki kodu, yoksa null olarak döner.
Detaylı Listeleme
Bu metod, kişileri tüm detayları ile sayfa sayfa almaya yarar.
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/Contacts/GetAll
Request
page (Integer: default:1)
pagesize (Integer: default:20)
Response
count (Integer)
page (Integer)
pageSize (Integer)
contacts (Array of Object)
Id (Integer)
Name (String): Kişi isim ve soyadı
Position (String): Kişinin titri
CompanyName (String): Şirketinin ismi
CompanyId (Integer): Şirketinin Id’si
Gender (String)
Description (String): Açıklama
Contactinfos (Array)
o ContactInfoType
Name (String): Şunlardan birisi olabilir:
Address
Email
Phone
Social
Web
SubType (String): Şunlardan birisi olabilir:
Address ise:
o Business
o Home
o Other
Email ise:
o Business
o Personal
o Other
Phone ise:
o Home
o Other
o Fax
o HomeFax
o DirectFax
o WorkMobile
Web ise:
o Website
Priority (Integer)
o Value
o SearchableValue (String)
o StateName (String)
o CityName (String)
o SpecialDate (DateTime?)
o ZipCode (String)
o ValuesOrder (Integer)
IsFavorite (Boolean): Favori
NotEmployed (Boolean): Hala çalışıp çalışmadığı
Tags (Array of String): Etiket isim listesi
IsOwn (Boolean)
CustomFieldDatas (Array): Özel alan veri listesi
o Id (Integer)
o CustomFieldId (Integer) : Özel alan Id’si
o IsRequired (Boolean)
o RelatedEntity: Siparişin müşterisi
Id (Integer)
Name (String) : Müşterinin adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Müşterinin tam adı
TaxNo (String)
TaxOffice (String)
o ScanCode (Boolean)
o ListValues (Array of String)
o UnFormettedDate (String) : Formatsız tarih
o UnFormattedNumber (String) : Formatsız rakam
o CustomFieldName (String) : Özel alan adı
o CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Value (String)
Values (String)
Owner: Şirketin sahibi/yetkili kişisi
o Id (Integer)
o Name (String)
EnteredDate (DateTime): Oluşturulduğu tarih
ModifiedDate (DateTime): Değiştirildiği tarih
LastActivityDate (DateTime): En son bu kişiyle ilgili işlem yapılma tarihi
EnteredBy: Giren kişi
o Id (Integer)
o Name (String)
ModifiedBy: Değiştiren kişi
o Id (Integer)
o Name (String)
LogoId (String): Bu kaydın varsa Logo programındaki kodu, yoksa null olarak döner.
Oluşturma
Bu metod ile yeni bir kişi oluşturabilirsiniz.
URL
POST https://api.teamgram.com/[ŞİRKETİSMİ]/CreateContact
Request
Name (String) (ZORUNLU): Kişi ismi
LastName (String) (ZORUNLU): Soyadı
CompanyName (String): Kişinin firması (Eğer bu isimde bir firma yoksa otomatik açılır)
Position (String): Pozisyonu
ContactInfos
o EmailWork (String[]): E-posta
o PhoneWork (String[]): İş telefonu
o AddressWork (String[]): İş adresi
o PhoneMobile (String[]): Cep telefonu
Description (String): Açıklama
NotEmployed (Boolean)
Tags (String array): Etiket listesi
ReadersIdToString (Array of String) : Okuma izinleri
WritersIdToString (Array of String) : Yazma izinleri
OwnerId : Sahibinin Id’si
CustomFieldDatas (Array): Özel alan veri listesi
o CustomFieldId (Integer) : Özel alan Id’si
o Value (String)
ProfilePhoto (HttpPostedFileBase .NET)
ClearProfilePhoto (Boolean)
ProfilePictures
o Small (String)
o Medium (String)
o Large (String)
o Original (String)
o SocialPicture (String)
DefaultDueDays (Integer?)
LogoId (String): Bu kayıdın varsa Logo programındaki kodu. Eğer bu kaydın Logoda
karşılığı yoksa bu değer gönderilmeyebilir yada null olarak gönderilebilir.
IdentityNo (String)
Response
Result (Boolean)
Id (Integer): oluşan kişinin unique Id’si
Message (String)
MessageCode (Integer)
o NULL: No error
o 0: GeneralError
o 1: EntityLimitExceeded
o 2: MaxStorageExceeded
o 3: MaxFileSizeExceeded
o 4: MonthlyMaxFilesExceeded
o 5: CreateRestriction
o 6: RequiredDataMissing
Değiştirme
Bu metod ile unique Id’si belli bir kişinin içeriğini değiştirebilirsiniz.
URL
POST https://api.teamgram.com/[ŞİRKETİSMİ]/Contacts/Edit
Id (Integer)
Name (String) (ZORUNLU): Kişi ismi
LastName (String) (ZORUNLU): Soyadı
CompanyName (String): Kişinin firması (Eğer bu isimde bir firma yoksa otomatik açılır)
Position (String): Pozisyonu
ContactInfos
o EmailWork (String[]): E-posta. Silmek için arrayi boş gönderin.
o PhoneWork (String[]): İş telefonu. Silmek için arrayi boş gönderin.
o AddressWork (String[]): İş adresi. Silmek için arrayi boş gönderin.
o PhoneMobile (String[]): Cep telefonu. Silmek için arrayi boş gönderin.
Description (String): Açıklama
NotEmployed (Boolean)
Tags (String array): Etiket listesi
ReadersIdToString (Array of String) : Okuma izinleri
WritersIdToString (Array of String) : Yazma izinleri
OwnerId : Sahibinin Id’si
CustomFieldDatas (Array): Özel alan veri listesi
o CustomFieldId (Integer) : Özel alan Id’si
o Value (String)
ProfilePhoto (HttpPostedFileBase .NET)
ClearProfilePhoto (Boolean)
ProfilePictures
o Small (String)
o Medium (String)
o Large (String)
o Original (String)
o SocialPicture (String)
DefaultDueDays (Integer?)
LogoId (String): Bu kayıdın varsa Logo programındaki kodu. Eğer bu kaydın Logoda
karşılığı yoksa bu değer gönderilmeyebilir yada null olarak gönderilebilir.
IdentityNo (String)
CanEditSharingRights (Boolean)
Owner : Firma sahibi
o Id (Integer)
o Displayname (String) : Adı
o ClassName (String) : Cinsi (Party, Individual etc.)
o TaxNo (String)
o TaxOffice (String)
CustomFields : (Array of Object)
o Id (Integer)
o Name (String) : Özel alan adı
o EntityType (String) : “Party”
o Type (Integer)
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Required (Boolean)
o PropertiesPulldownStrings (String Array) : Pulldown tipli alanların içeriği
o PropertiesScanCode (Boolean?)
o Order (Integer) : Görünme sırası
Response
Result (Boolean)
Id (Integer)
Message (String)
MessageCode (Integer)
o NULL: No error
o 0: GeneralError
o 1: EntityLimitExceeded
o 2: MaxStorageExceeded
o 3: MaxFileSizeExceeded
o 4: MonthlyMaxFilesExceeded
o 5: CreateRestriction
o 6: RequiredDataMissing
Errors
404 – Contact not found
404 – No access
Görme
Bu metod ile unique Id’si belli bir kontağın tüm detaylarını görebilirsiniz.
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/Contact
Request
Id (Integer)
Response
Id (Integer)
Name (String): Kişi isim ve soyadı
Position (String): Kişinin titri
CompanyName (String): Şirketinin ismi
CompanyId (Integer): Şirketinin Id’si
Gender (String)
Description (String): Açıklama
Contactinfos (Array)
o ContactInfoType
Name (String): Şunlardan birisi olabilir:
Address
Email
Phone
Social
Web
SubType (String): Şunlardan birisi olabilir:
Address ise:
o Business
o Home
o Other
Email ise:
o Business
o Personal
o Other
Phone ise:
o Home
o Other
o Fax
o HomeFax
o DirectFax
o WorkMobile
Web ise:
o Website
Priority (Integer)
o Value
o SearchableValue (String)
o StateName (String)
o CityName (String)
o SpecialDate (DateTime?)
o ZipCode (String)
o ValuesOrder (Integer)
IsFavorite (Boolean): Favori
NotEmployed (Boolean): Hala çalışıp çalışmadığı
Tags (Array of String): Etiket isim listesi
IsOwn (Boolean)
CustomFieldDatas (Array): Özel alan veri listesi
o Id (Integer)
o CustomFieldId (Integer) : Özel alan Id’si
o IsRequired (Boolean)
o RelatedEntity: Siparişin müşterisi
Id (Integer)
Name (String) : Müşterinin adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Müşterinin tam adı
TaxNo (String)
TaxOffice (String)
o ScanCode (Boolean)
o ListValues (Array of String)
o UnFormettedDate (String) : Formatsız tarih
o UnFormattedNumber (String) : Formatsız rakam
o CustomFieldName (String) : Özel alan adı
o CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Value (String)
Values (String)
Owner: Şirketin sahibi/yetkili kişisi
o Id (Integer)
o Name (String)
EnteredDate (DateTime): Oluşturulduğu tarih
ModifiedDate (DateTime): Değiştirildiği tarih
LastActivityDate (DateTime): En son bu kişiyle ilgili işlem yapılma tarihi
EnteredBy: Giren kişi
o Id (Integer)
o Name (String)
ModifiedBy: Değiştiren kişi
o Id (Integer)
o Name (String)
LogoId (String): Bu kaydın varsa Logo programındaki kodu, yoksa null olarak döner.
OrgBoxId (Integer)
OrgBoxName (String)
PrimaryEmail (String)
RoleName (String)
DefaultDueDays (Integer?)
LogoId (String)
Extension (String)
IdentityNo (String)
Errors
404 – Company not found
404 – No access
Silme
Bu metod ile kişileri silebilirsiniz.
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/DeleteContact
Request
Id (Integer)
Response
Result: (Boolean)
Errors
404 – Company not found
404 – No access
Ürünler
Listeleme
Bu metod, ürünleri sayfa sayfa almaya yarar ancak ürünlerin tüm detayları gelmez. Vereceği veriler
için bazı filtre özellikleri mevcuttur.
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/Products/Index
Request
page (Integer: default:1)
pagesize (Integer: default:20)
fid (integer: default:null)
o 0: Tüm şirketler
o N: Bu kullanıcı için tanımlanmış bir filtrenin Id’si (TeamGram arayüzünden
tanımlanabilir)
Response
count (Integer): Toplam kişi sayısı
page (Integer): Bulunulan sayfa
pageSize (Integer): Sayfada bulunan toplam kayıt sayısı
letter (String)
CustomFields (Array of Object)
o Id (Integer)
o Name (String): Özel alan adı
o EntityType (String): “Party”
o Type (Integer)
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Required (Boolean)
o PropertiesPulldownStrings (String Array): Pulldown tipli alanların içeriği
o Order (Integer): Gösterilme sırası
Products (Array of Object)
o Id (Integer)
o DisplayName (String): Ürünün Marka+Model+İsim toplamı
o Brand (String): Ürünün markası
o ProdModel (String): Ürünün modeli
o Description (String): Ürünün ismi
o Sku (String): Ürünün müşteri tarafından belirlenen ürün kodu
o Price (Double): Ürünün satış fiyatı
o CurrencyName (String): Ürünün satış para birimi ismi
o PurchasePrice (Double): Ürünün alış fiyatı
o PurchaseCurrencyName (String): Ürünün alış para birimi ismi
o NotAvaliable (Boolean): Ürün var mı yok mu
o ProfilePictures
Small (String)
Medium (String)
Large (String)
Original (String)
o Vat (Nullable Double): Ürünün % KDVsi
o Details (String): Ürünün açıklaması
o Unit (String): Ürünün birimi
o LogoId (String): Bu kayıdın varsa Logo programındaki kodu. Eğer bu kaydın Logoda
karşılığı yoksa bu değer gönderilmeyebilir yada null olarak gönderilebilir
o Inventory (Double?): Stok adeti
o CriticalInventory (Double?): Kritik stok adeti
o NoInventory (Boolean): Stok kullanımı
o IsFavorite (Boolean): Favori
o Category: Ürünün kategorisi
Id (Integer): Id’si
Name (String): Adı
Filters (Array of Object)
o Name (String)
o Id (Integer)
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/Products/GetUpdated
Request
fromDate (string)
o Tarih formatı iso8601: (YYYY-MM-DD) Örnek: ?fromDate=2016-11-30
page (Integer: default:1)
pagesize (Integer: default:20)
Response
count (Integer)
page (Integer)
pageSize (Integer)
products (Array of Object)
Id (Integer)
DisplayName (String): Ürünün marka/model ve isminden oluşan toplu ismi
Price (Double?): Ürünün satış fiyatı.
CurrencyName (String): Ürünün satış fiyatının para birimi.
PurchasePrice (Double?): Ürünün alış fiyatı.
PurchaseCurrencyName (String): Ürünün alış fiyatının para birimi.
ProfilePictureFileKey (String)
Brand (String): Ürünün markası
ProdModel (String): Ürünün modeli
Description (String): Ürünün ismi
Sku (String): Ürünün müşteri tarafından belirlenen ürün kodu
NotAvaliable (Boolean)
Details (String) : Detaylar
Tags (Array of String): Etiket isim listesi
CustomFieldDatas (Array): Özel alan veri listesi
o Id (Integer)
o CustomFieldId (Integer) : Özel alan Id’si
o IsRequired (Boolean)
o RelatedEntity: Ürünün müşterisi
Id (Integer)
Name (String) : Müşterinin adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Müşterinin tam adı
TaxNo (String)
TaxOffice (String)
o ScanCode (Boolean)
o ListValues (Array of String)
o UnFormettedDate (String) : Formatsız tarih
o UnFormattedNumber (String) : Formatsız rakam
o CustomFieldName (String) : Özel alan adı
o CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Value (String)
o Values (String)
ReadersIdToString (Array of String) : Ürünün okuma izinleri
WritersIdToString (Array of String) : Ürünün yazma izinleri
CanEdit (Boolean)
CanEditSharingRights (Boolean)
Owner : Ürünün sahibi
o Id (Integer)
o Displayname (String) : Adı
o ClassName (String) : Cinsi (Party, Individual etc.)
o TaxNo (String)
o TaxOffice (String)
ProfilePictures
o Small (String)
o Medium (String)
o Large (String)
o Original (String)
o SocialPicture (String)
EnteredDate (DateTime): Oluşturulduğu tarih
ModifiedDate (DateTime): Değiştirildiği tarih
LastActivityDate (DateTime): En son bu ürünle ilgili işlem yapılma tarihi
EnteredBy: Giren kişi
o Id (Integer)
o Name (String)
ModifiedBy: Değiştiren kişi
o Id (Integer)
o Name (String)
Vat (Nullable Double): Ürünün % KDVsi
Unit (String): Ürünün birimi
RelatedEntity: Ürünün müşterisi
o Id (Integer)
o Name (String) : Müşterinin adı
o LastName (String)
o ClassName (String) : Cinsi (Party, Individual etc.)
o Displayname (String) : Müşterinin tam adı
o TaxNo (String)
o TaxOffice (String)
LogoId (String): Bu kaydın varsa Logo programındaki kodu, yoksa null olarak döner
Request
Id (Integer)
page (Integer: default:1)
pagesize (Integer: default:20)
Response
count (Integer)
page (Integer)
pageSize (Integer)
products (Array of Object)
Id (Integer)
DisplayName (String): Ürünün marka/model ve isminden oluşan toplu ismi
Price (Double?): Ürünün satış fiyatı.
CurrencyName (String): Ürünün satış fiyatının para birimi.
PurchasePrice (Double?): Ürünün alış fiyatı.
PurchaseCurrencyName (String): Ürünün alış fiyatının para birimi.
ProfilePictureFileKey (String)
Brand (String): Ürünün markası
ProdModel (String): Ürünün modeli
Description (String): Ürünün ismi
Sku (String): Ürünün müşteri tarafından belirlenen ürün kodu
NotAvaliable (Boolean)
Details (String) : Detaylar
Tags (Array of String): Etiket isim listesi
CustomFieldDatas (Array): Özel alan veri listesi
o Id (Integer)
o CustomFieldId (Integer) : Özel alan Id’si
o IsRequired (Boolean)
o RelatedEntity: Ürünün müşterisi
Id (Integer)
Name (String) : Müşterinin adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Müşterinin tam adı
TaxNo (String)
TaxOffice (String)
o ScanCode (Boolean)
o ListValues (Array of String)
o UnFormettedDate (String) : Formatsız tarih
o UnFormattedNumber (String) : Formatsız rakam
o CustomFieldName (String) : Özel alan adı
o CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Value (String)
o Values (String)
ReadersIdToString (Array of String) : Ürünün okuma izinleri
WritersIdToString (Array of String) : Ürünün yazma izinleri
CanEdit (Boolean)
CanEditSharingRights (Boolean)
Owner : Ürünün sahibi
o Id (Integer)
o Displayname (String) : Adı
o ClassName (String) : Cinsi (Party, Individual etc.)
o TaxNo (String)
o TaxOffice (String)
ProfilePictures
o Small (String)
o Medium (String)
o Large (String)
o Original (String)
o SocialPicture (String)
EnteredDate (DateTime): Oluşturulduğu tarih
ModifiedDate (DateTime): Değiştirildiği tarih
LastActivityDate (DateTime): En son bu ürünle ilgili işlem yapılma tarihi
EnteredBy: Giren kişi
o Id (Integer)
o Name (String)
ModifiedBy: Değiştiren kişi
o Id (Integer)
o Name (String)
Vat (Nullable Double): Ürünün % KDVsi
Unit (String): Ürünün birimi
IsFavorite (Boolean): Favori
RelatedEntity: Ürünün müşterisi
o Id (Integer)
o Name (String) : Müşterinin adı
o LastName (String)
o ClassName (String) : Cinsi (Party, Individual etc.)
o Displayname (String) : Müşterinin tam adı
o TaxNo (String)
o TaxOffice (String)
LogoId (String): Bu kaydın varsa Logo programındaki kodu, yoksa null olarak döner..
Inventory (Double?): Stok adeti
CriticalInventory (Double?): Kritik stok adeti
NoInventory (Boolean): Stok kullanımı
Category: Ürünün kategorisi
o Id (Integer): Id’si
o Name (String): Adı
Detaylı Listeleme
Bu metod, ürünleri tüm detayları ile sayfa sayfa almaya yarar.
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/Products/GetAll
Request
page (Integer: default:1)
pagesize (Integer: default:20)
Response
count (Integer)
page (Integer)
pageSize (Integer)
products (Array of Object)
Id (Integer)
DisplayName (String): Ürünün marka/model ve isminden oluşan toplu ismi
Price (Double?): Ürünün satış fiyatı.
CurrencyName (String): Ürünün satış fiyatının para birimi.
PurchasePrice (Double?): Ürünün alış fiyatı.
PurchaseCurrencyName (String): Ürünün alış fiyatının para birimi.
ProfilePictureFileKey (String)
Brand (String): Ürünün markası
ProdModel (String): Ürünün modeli
Description (String): Ürünün ismi
Sku (String): Ürünün müşteri tarafından belirlenen ürün kodu
NotAvaliable (Boolean)
Details (String) : Detaylar
Tags (Array of String): Etiket isim listesi
CustomFieldDatas (Array): Özel alan veri listesi
o Id (Integer)
o CustomFieldId (Integer) : Özel alan Id’si
o IsRequired (Boolean)
o RelatedEntity: Ürünün müşterisi
Id (Integer)
Name (String) : Müşterinin adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Müşterinin tam adı
TaxNo (String)
TaxOffice (String)
o ScanCode (Boolean)
o ListValues (Array of String)
o UnFormettedDate (String) : Formatsız tarih
o UnFormattedNumber (String) : Formatsız rakam
o CustomFieldName (String) : Özel alan adı
o CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Value (String)
o Values (String)
ReadersIdToString (Array of String) : Ürünün okuma izinleri
WritersIdToString (Array of String) : Ürünün yazma izinleri
CanEdit (Boolean)
CanEditSharingRights (Boolean)
Owner : Ürünün sahibi
o Id (Integer)
o Displayname (String) : Adı
o ClassName (String) : Cinsi (Party, Individual etc.)
o TaxNo (String)
o TaxOffice (String)
ProfilePictures
o Small (String)
o Medium (String)
o Large (String)
o Original (String)
o SocialPicture (String)
EnteredDate (DateTime): Oluşturulduğu tarih
ModifiedDate (DateTime): Değiştirildiği tarih
LastActivityDate (DateTime): En son bu ürünle ilgili işlem yapılma tarihi
EnteredBy: Giren kişi
o Id (Integer)
o Name (String)
ModifiedBy: Değiştiren kişi
o Id (Integer)
o Name (String)
Vat (Nullable Double): Ürünün % KDVsi
Unit (String): Ürünün birimi
IsFavorite (Boolean): Favori
RelatedEntity: Ürünün müşterisi
o Id (Integer)
o Name (String) : Müşterinin adı
o LastName (String)
o ClassName (String) : Cinsi (Party, Individual etc.)
o Displayname (String) : Müşterinin tam adı
o TaxNo (String)
o TaxOffice (String)
LogoId (String): Bu kaydın varsa Logo programındaki kodu, yoksa null olarak döner
Inventory (Double?): Stok adeti
CriticalInventory (Double?): Kritik stok adeti
NoInventory (Boolean): Stok kullanımı
Category: Ürünün kategorisi
o Id (Integer): Id’si
o Name (String): Adı
Oluşturma
Bu metod ile yeni bir ürün oluşturabilirsiniz.
URL
POST https://api.teamgram.com/[ŞİRKETİSMİ]/Products/Create
Request
Brand (String): Ürünün markası
ProdModel (String): Ürünün modeli
Description (String): Ürünün ismi
Sku (String): Ürünün müşteri tarafından belirlenen ürün kodu
Price (Double?): Ürünün satış fiyatı
CurrencyId (Integer): Ürünün satış para birimi Id’si
PurchasePrice (Double): Ürünün alış fiyatı
PurchaseCurrencyId (Integer): Ürünün alış para birimi Id’si
Details (String): Ürünün açıklaması
NotAvaliable (Boolean): Ürün var mı yok mu
Tags (String array): Etiket listesi
ReadersIdToString (Array of String) : Ürünün okuma izinleri
WritersIdToString (Array of String) : Ürünün yazma izinleri
CanEditSharingRights (Boolean)
OwnerId (Integer) : Ürünün sahibinin Id’si
ProfilePhoto (HttpPostedFileBase .NET)
CustomFieldDatas (Array): Özel alan veri listesi
o CustomFieldId (Integer) : Özel alan Id’si
o Value (String)
ClearProfilePhoto (Boolean)
Vat (Nullable Double): Ürünün % KDVsi
CategoryId (Integer?): Kategorinin Id’si (null ise hiçbir işlem yapılmaz. “0” ise silinir. Diğer
durumlarda kategori eklenir.)
Unit (String): Ürünün birimi
RelatedEntityId (Integer) : Ürünün müşteri Id’si
LogoId (String): Bu kayıdın varsa Logo programındaki kodu. Eğer bu kaydın Logoda
karşılığı yoksa bu değer gönderilmeyebilir yada null olarak gönderilebilir
Response
Result (Boolean)
Id (Integer): oluşan ürünün unique Id’si
Message (String)
MessageCode (Integer)
o NULL: No error
o 0: GeneralError
o 1: EntityLimitExceeded
o 2: MaxStorageExceeded
o 3: MaxFileSizeExceeded
o 4: MonthlyMaxFilesExceeded
o 5: CreateRestriction
o 6: RequiredDataMissing
Değiştirme
Bu metod ile unique Id’si belli bir şirketin içeriğini değiştirebilirsiniz.
URL
POST https://api.teamgram.com/[ŞİRKETİSMİ]/Products/Edit
Request
Id (Integer) (ZORUNLU): Değiştirilecek ürünün Id’si
Brand (String): Ürünün markası
ProdModel (String): Ürünün modeli
Description (String): Ürünün ismi
Sku (String): Ürünün müşteri tarafından belirlenen ürün kodu
Price (Double?): Ürünün satış fiyatı
CurrencyId (Integer): Ürünün satış para birimi Id’si
PurchasePrice (Double): Ürünün alış fiyatı
PurchaseCurrencyId (Integer): Ürünün alış para birimi Id’si
Details (String): Ürünün açıklaması
NotAvaliable (Boolean): Ürün var mı yok mu
Tags (String array): Etiket listesi
ReadersIdToString (Array of String) : Ürünün okuma izinleri
WritersIdToString (Array of String) : Ürünün yazma izinleri
CanEditSharingRights (Boolean)
OwnerId (Integer) : Ürünün sahibinin Id’si
ProfilePhoto (HttpPostedFileBase .NET)
CustomFieldDatas (Array): Özel alan veri listesi
o CustomFieldId (Integer) : Özel alan Id’si
o Value (String)
ClearProfilePhoto (Boolean)
Vat (Nullable Double): Ürünün % KDVsi
CategoryId (Integer?): Kategorinin Id’si (null ise hiçbir işlem yapılmaz. “0” ise silinir. Diğer
durumlarda kategori eklenir.)
Unit (String): Ürünün birimi
RelatedEntityId (Integer) : Ürünün müşteri Id’si
LogoId (String): Bu kayıdın varsa Logo programındaki kodu. Eğer bu kaydın Logoda
karşılığı yoksa bu değer gönderilmeyebilir yada null olarak gönderilebilir
Response
Result (Boolean)
Id (Integer)
Message (String)
Errors
404 – Product not found
404 – No access
MessageCode (Integer)
o NULL: No error
o 0: GeneralError
o 1: EntityLimitExceeded
o 2: MaxStorageExceeded
o 3: MaxFileSizeExceeded
o 4: MonthlyMaxFilesExceeded
o 5: CreateRestriction
o 6: RequiredDataMissing
Görme
Bu metod ile unique Id’si belli bir ürünün tüm detaylarını görebilirsiniz.
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/Products/Get
Request
Id (Integer)
Response
Id (Integer)
DisplayName (String): Ürünün marka/model ve isminden oluşan toplu ismi
Price (Double?): Ürünün satış fiyatı.
CurrencyName (String): Ürünün satış fiyatının para birimi.
PurchasePrice (Double?): Ürünün alış fiyatı.
PurchaseCurrencyName (String): Ürünün alış fiyatının para birimi.
ProfilePictureFileKey (String)
Brand (String): Ürünün markası
ProdModel (String): Ürünün modeli
Description (String): Ürünün ismi
Sku (String): Ürünün müşteri tarafından belirlenen ürün kodu
NotAvaliable (Boolean)
Details (String) : Detaylar
Tags (Array of String): Etiket isim listesi
CustomFieldDatas (Array): Özel alan veri listesi
o Id (Integer)
o CustomFieldId (Integer) : Özel alan Id’si
o IsRequired (Boolean)
o RelatedEntity: Ürünün müşterisi
Id (Integer)
Name (String) : Müşterinin adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Müşterinin tam adı
TaxNo (String)
TaxOffice (String)
o ScanCode (Boolean)
o ListValues (Array of String)
o UnFormettedDate (String) : Formatsız tarih
o UnFormattedNumber (String) : Formatsız rakam
o CustomFieldName (String) : Özel alan adı
o CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Value (String)
o Values (String)
ReadersIdToString (Array of String) : Ürünün okuma izinleri
WritersIdToString (Array of String) : Ürünün yazma izinleri
CanEdit (Boolean)
CanEditSharingRights (Boolean)
Owner : Ürünün sahibi
o Id (Integer)
o Displayname (String) : Adı
o ClassName (String) : Cinsi (Party, Individual etc.)
o TaxNo (String)
o TaxOffice (String)
ProfilePictures
o Small (String)
o Medium (String)
o Large (String)
o Original (String)
o SocialPicture (String)
EnteredDate (DateTime): Oluşturulduğu tarih
ModifiedDate (DateTime): Değiştirildiği tarih
LastActivityDate (DateTime): En son bu ürünle ilgili işlem yapılma tarihi
EnteredBy: Giren kişi
o Id (Integer)
o Name (String)
ModifiedBy: Değiştiren kişi
o Id (Integer)
o Name (String)
Vat (Nullable Double): Ürünün % KDVsi
Unit (String): Ürünün birimi
RelatedEntity: Ürünün müşterisi
o Id (Integer)
o Name (String) : Müşterinin adı
o LastName (String)
o ClassName (String) : Cinsi (Party, Individual etc.)
o Displayname (String) : Müşterinin tam adı
o TaxNo (String)
o TaxOffice (String)
LogoId (String): Bu kaydın varsa Logo programındaki kodu, yoksa null olarak döner
IsFavorite (Boolean): Favori
Inventory (Double?): Stok
CriticalInventory (Double?): Kritik stok miktarı
NoInventory (Boolean): Stoksuz
Category: Ürünün kategorisi
o Id (Integer): Id’si
o Name (String): Adı
Errors
404 – Product not found
404 – No access
Silme
Bu metod ile ürünleri silebilirsiniz.
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/Products/Delete
Request
Id (Integer) (ZORUNLU)
Response
Result: (Boolean)
Errors
404 – Product not found
404 – No access
Result: false (Siparişlerde kullanıldığı için silinemiyor)
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/Products/InventoryAdjustment
Request
nInvAdj_Desc (Integer): Açıklama
nInvAdj_Indate (Double): Tarih
nInvAdj_ProductId (Integer): Ürün Id’si
nInvAdj_Quantity (Double): Ürün stok adeti
nInvAdj_Reason (Integer): Stok hareketinin nedeni
0 – Error
1 – PurchaseOrderDelivered
2 – InventoryPurchased
3 – InventoryProduced
4 – InventoryRecovered
5 – CustomerReturned
6 – OtherIncrease
7 – IntegrationIncrease
8 – CustomerOrderShipped
9 – InventorySold
10 – InventoryUsed
11 – InventoryLost
12 – ReturnedToVendor
13 - OtherDecrease
14 - IntegrationDecrease
15 - InventoryCountIncrease
16 – InventoryCountDecrease
Response
Success (Boolean): İşlem sonucu
Description (String): Açıklama, sadece success false durumda ise döner
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/Products/InventoryAdjustmentDelete
Request
id (Integer): Stok hareketi Id’si
Response
success (Boolean): İşlem sonucu
inventory (String): Güncel adet
Stok listeleme
Bu metod, stok işlemlerini listeler.
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/Products/InventoryOfEntity
Request
entityId (Integer): Ürün Id’si
page (Integer: default:1): Sayfa numarası
pagesize (Integer: default:20): Sayfa veri adeti
inv_ttype (Integer?: default:null): Stok hareketinin nedeni
o 0 – Error
o 1 – PurchaseOrderDelivered
o 2 – InventoryPurchased
o 3 – InventoryProduced
o 4 – InventoryRecovered
o 5 – CustomerReturned
o 6 – OtherIncrease
o 7 – IntegrationIncrease
o 8 – CustomerOrderShipped
o 9 – InventorySold
o 10 – InventoryUsed
o 11 – InventoryLost
o 12 – ReturnedToVendor
o 13 - OtherDecrease
o 14 - IntegrationDecrease
o 15 - InventoryCountIncrease
o 16 – InventoryCountDecrease
Response
Count (Integer): Toplam veri adeti
CanExport (Boolean): Dışarıya aktarma izni
Inventory (Double): Stokların toplam adeti. Örn: İki hafta sonrası için stok adeti olsun. Şu anki
adet ile olan toplamı.
InventoryNow (Double): Şu anki adet
InventoryLater (Double): Gelecek adet
HasItems (Boolean): Veri var
Unit (String): Birimi
ProductId (Integer): Ürün Id’si
ProductCriticalInventory (Double?): Kritik stok adeti
Items (Array Of Object): Stok hareketleri
o Id (Integer): Id’si
o Indate (DateTime): Tarihi
o EnteredByIndividualDisplayname (String): Giren kişinin tam adı
o Product (Object): Ürün
Id (Integer): Id’si
Name (String) : Adı
Brand (String) : Markası
ProdModel (String) : Modeli
Sku (String) : Müşteri tarafından belirlenen ürün kodu
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Tam adı
o Quantity (Double): Girilen adet
o Reason (String): Hareket nedeni
o Description (String): Açıklama
İnv_ttype (Integer?): Stok hareketinin nedeni
Metadata
Para birimleri Id’leri gibi bilgileri bu şirket için çekmeye yarar.
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/ScheduledRequests/MetaData
Response
CurrentIndividual (Kullanıcının bilgileri)
o OrgBoxId (Integer): Kullanıcının bu şirketteki Id’si
o OrgBoxName (String): Kullanınıcının bulunduğu departman
o Position (String) : Kullanıcının pozisyonu
o PrimaryEmail (String): Kullanıcının epostası
o RoleName (String): Admin veya User
o Id (Integer)
o Name (String) : Kullanıcının Adı
o Controller (String)
o Own (Boolean)
o ProfilePictureFileKey (String) : Profile resmine ait key
Domains (Array of dynamic)
o Id (Integer) : Domain Id’si
o Name (String) : Domain adı
o DisplayName (String) : Domain tam adı
o Currency : Para birimi
Id (Integer) : Para birimi Id’si
Name (String) : Para biriminin karşılığı
o TimeZone (String) : Saat dilimi
o UsesVat (Boolean) : Kdv kullanımı
o DefaultVat (Double?)
o Address (String)
o PhoneNumber (String)
o ProposalDefaultExpiryDay (Integer?)
o PaidDomain (Boolean)
CustomApplications
o CustomFields (Array of Object)
Id (Integer)
Name (String) : Özel alan adı
EntityType (String) : “Party”
Type (Integer)
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
Required (Boolean)
PropertiesPulldownStrings (String Array) : Pulldown tipli alanların içeriği
Order (Integer) : Gösterilme sırası
o ReadersIdToString (Array of String) : Okuma izinleri
o WritersIdToString (Array of String) : Yazma izinleri
o Id (Integer)
o Name (String)
o Icon (String)
o Approval (Boolean) : Onaylama
CustomStages
o Id (Integer)
o Name (String)
o Color (String)
CustomStagesOrder
o Id (Integer)
o Name (String)
o Color (String)
CustomStagesPurchase
o Id (Integer)
o Name (String)
o Color (String)
CustomFieldsOrder (Array of Object)
o Id (Integer)
o Name (String): Özel alan adı
o EntityType (String): “Party”
o Type (Integer)
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Required (Boolean)
o PropertiesPulldownStrings (String Array): Pulldown tipli alanların içeriği
o Order (Integer): Gösterilme sırası
OwnIndividualList (Array of Object) (kullanıcıları listesi)
o OrgBoxId (Integer): Kullanıcının bu şirketteki Id’si
o OrgBoxName (String): Kullanınıcının bulunduğu departman
o Position (String) : Kullanıcının pozisyonu
o PrimaryEmail (String): Kullanıcının epostası
o RoleName (String): Admin veya User
o Id (Integer)
o Name (String)
o Controller (String)
o Own (Boolean)
o ProfilePictureFileKey (String)
OrgBoxList
o Id (Integer) : Departman Id’si
o Name (String) : Departman adı
Currencies (Array of Object) : Para birimi
o Id (Integer): Para biriminin Id’si
o Name (String): Para biriminin ismi
o Rate (Double): Para biriminin dolara karşı güncel kuru (1 USD=1)
OrgBoxSharingSettings
o OrgBoxes (Array of Object)
OrgBoxId (Integer) : Departman Id’si
OrgBoxName (String) : Departman adı
OrgBoxSharings (Array of Object)
ItemType (String) : Bireysel veya kurumsal bilgisidir
Readers (Array of Object)
o Id (Integer)
o Name (String)
o ClassName (String)
Writers (Array of Object)
o Id (Integer)
o Name (String)
o ClassName (String)
CantRecordsCreate (Boolean) : Yeni kayıt oluşturamaz
CantRightChange (Boolean) : İzinleri değiştiremez
TimeZone (Array of Object) : Saat dilimlerinin listesidir
o Id (String) : Zaman diliminin başlığı
o Name (String) : Zaman diliminin detayları
SectionNames (Array of Object): Menü isimlendirmesi
o Section (String)
o Name (String)
Categories (Array of Object): Tüm kategorilerin listesi
o Id (Integer): Kategori Id’si
o Name (String): Kategori adı
o ParentId (Integer): Eğer varsa, altında bulunduğu kategorinin Id’si
Müşteri Sipariş
Listeleme
Bu metod, siparişleri sayfa sayfa almaya yarar ancak siparişlerin tüm detayları gelmez. Vereceği
veriler için bazı filtre özellikleri mevcuttur.
URL
https://api.teamgram.com/v1/[ŞİRKETİSMİ]/Orders/Index
Request
page (Integer: default:1)
pagesize (Integer: default:20)
ofid (Integer: default:0) : Bir objenin siparişleri. (Örneğin: Bir ürün Id’si veya bir şirket
Id’si)
fid (Integer: default:null)
o 0: Açık siparişler (Sipariş tarihi sıralı)
o -1: Kapanan siparişler
o -2: Açık siparişler (Tamamlanma tarihi sıralı)
o -3: Açık siparişler (No. sıralı)
o N: Bu kullanıcı için tanımlanmış bir filtrenin Id’si (TeamGram arayüzünden
tanımlanabilir)
Response
Filters (Array of Object)
o Name (String) : Filtrenin adı
o Id (Integer) : Filtrenin Id’si
List (Array of Object)
o ActualFulfilment (Datetime?) : Eğer var ise gerçekleşen teslim tarihi
o ScheduledFulfilment (DateTime?) : Eğer var ise teslim tarihi
o OrderDate (DateTime) : Sipariş tarihi
o Stage (Integer) : Siparişin aşaması
0 – Choose (Seç)
1 – Pending (Bekliyor)
2 – Processing (Hazırlanıyor)
3 – Shipped (Sevk edildi)
o Status (Integer) : Siparişin durumu
0 – OpenNew (Açık)
1 – ClosedFulfilled (Tamamlandı)
2 – Cancelled (İptal)
o CustomStageName (String) : Eğer özelleştirilmiş aşama kullanılıyorsa, özel
aşamanın adı
o CustomStageId (Integer) : Eğer özelleştirilmiş aşama kullanılıyorsa, özel aşamanın
Id’si
o Id (Integer) : Siparişin Id’si
o Name (String) : Siparişin adı
o Displayname (String) : Siparişin uzun adı
o CurrencyName (String) : Kullanılan para biriminin adı
o RelatedEntities (Array of Object) : Siparişin ilişkili olduğu diğer objeler
Id (Integer)
Displayname (String) : Adı
ClassName (String) : Cinsi (Party, Individual etc.)
o RelatedEntity: Siparişin müşterisi
Id (Integer)
Displayname (String) : Adı
ClassName (String) : Cinsi (Party, Individual etc.)
o Owner : Siparişin sahibi
Id (Integer)
Displayname (String) : Adı
ClassName (String) : Cinsi (Party, Individual etc.)
o Tags (Array of String) : Etiketler
o LastActivityDate (DateTime?) : Siparişin en son aktivite tarihi
o EnteredDate (DateTime) : Siparişin oluşturulduğu tarih
o ModifiedDate (DateTime?) : Siparişin en son değiştirildiği tarih
o DiscountType (Integer) : Siparişin indirim tipi
0 – PercentOff : Yüzde indirim
1 – AmountOff : Miktar indirimi
o Discount (Double) : Siparişin indirim miktarı
o DiscountCurrencyName (String) : Eğer miktar indirimi ise indirimin para birimi
o ParentProposal : Eğer var ise siparişin teklifi
Id (Integer)
Name (String) : Siparişin adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Siparişin tam adı
o ModifiedBy : Siparişi en son değiştiren
Id (Integer)
Name (String) : Kişinin adı
o EnteredBy: Siparişi oluşturan
Id (Integer)
Name (String) : Kişinin adı
o VatType (Integer) : Kdv kullanımı
0 – NoVat : Kdv yok
1 – VatExclusive : Kdv hariç
2 – VatInclusive : Kdv dahil
o AddedToAccounting (Boolean) : Cari hesaplara eklenmiş
o MailSent (Boolean) : Bu sipariş için müşteriye mail gönderilmiş
o CustomRates : Kullanılan kurlar
FromCurrencyName (String) : Hangi para biriminden
ToCurrencyName (String): Hangi para birimine
Rate (Double) : Oran
CustomFields (Array of Object)
o Id (Integer)
o Name (String) : Özel alan adı
o EntityType (String) : “Party”
o Type (Integer)
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Required (Boolean)
o PropertiesPulldownStrings (String Array) : Pulldown tipli alanların içeriği
o Order (Integer) : Gösterilme sırası
OrderCount (Integer) : Dönen sipariş adedi
URL
GET https://api.teamgram.com/v1/[ŞİRKETİSMİ]/Orders/GetNew
Request
Id (Integer)
page (Integer: default:1)
pagesize (Integer: default:20)
Response
count (Integer)
page (Integer)
pageSize (Integer)
orders (Array of Object): Görme metodunun döndürdüğü objenin aynısını döndürür.
Oluşturma
Bu metod ile yeni bir sipariş oluşturabilirsiniz.
URL
POST https://api.teamgram.com/v1/[ŞİRKETİSMİ]/Orders/Create
Request
OrderDate (Datetime) : Sipariş Tarihi
ScheduledFulfilment (DateTime?) : Eğer var ise teslim tarihi
DeliveryAddress (String) : Teslimat adresi
BillingAddress (String) : Fatura Adersi
Stage (Integer) : Siparişin aşaması
o 0 – Choose (Seç)
o 1 – Pending (Bekliyor)
o 2 – Processing (Hazırlanıyor)
o 3 – Shipped (Sevk edildi)
Status (Integer) : Siparişin durumu
o 0 – OpenNew (Açık)
o 1 – ClosedFulfilled (Tamamlandı)
o 2 – Cancelled (İptal)
Description : Sipariş açıklaması
CustomStageId : Eğer özel aşamalar kullanılıyorsa özel aşamanın Id’si
ParentProposalId : Sipariş bir teklife bağlı ise bağlı olduğu teklifinin Id’si
Tags (Array of String) : Etiketler
Name (String) : Sipariş adı
RelatedEntityId (Integer) : Siparişin müşteri Id’si
RelatodOpportunityId (Integer)
Items (Array of Object) : Siparişin detayları
o Product : Ürün
Id (Integer): Ürünün Id’si
o Quantity (Double) : Miktarı
o Price (Double) : Fiyatı
o CurrencyName (String) : Para birimi
o Description (String) : Açıklama
o Vat (Double?) : Kdv
o DiscountType (Integer) : Satırın indirim tipi
0 – PercentOff : Yüzde indirim
1 – AmountOff : Miktar indirimi
o Discount (Double) : Satırın indirim miktarı
o Unit (String) : Birimi
CustomFieldDatas (Array) : Özel alan veri listesi
o CustomFieldId (Integer) : Özel alan Id’si
o Value (String)
RelatedEntityIds (String)
Discount (Double?) : Siparişin İndirim miktarı
DiscountType (Integer) : Siparişin İndirim tipi
o 0 – PercentOff : Yüzde indirim
o 1 – AmountOff : Miktar indirimi
DiscountCurrencyName (String) : Eğer miktar indirimi ise indirimin para birimi
OwnerId (Integer) : Siparişin sahibinin Id’si
VatType (Integer): Kdv kullanımı
o 0 – NoVat: Kdv yok
o 1 – VatExclusive: Kdv hariç
o 2 – VatInclusive: Kdv dahil
CustomerPhone (String)
TemplateId (Integer?)
CustomRates : Özel fiyatlar
o FromCurrencyName (String) : Hangi para biriminden
o ToCurrencyName (String): Hangi para birimine
o Rate (Double) : Oran
Response
Result (Boolean)
Message (String) : Hata mesajını temsil eder
MessageCode (Integer) : Hatanın kodu
o NULL: No error
o 0: GeneralError
o 1: EntityLimitExceeded
o 2: MaxStorageExceeded
o 3: MaxFileSizeExceeded
o 4: MonthlyMaxFilesExceeded
o 5: CreateRestriction
o 6: RequiredDataMissing
Değiştirme
Bu metod gelen modeli kaydeder.
URL
POST https://api.teamgram.com/v1/[ŞİRKETİSMİ]/Orders/Edit
Request
Id (Integer)
OrderDate (Datetime) : Sipariş Tarihi
ScheduledFulfilment (DateTime?) : Eğer var ise teslim tarihi
DeliveryAddress (String) : Teslimat adresi
BillingAddress (String) : Fatura Adersi
Stage (Integer) : Siparişin aşaması
o 0 – Choose (Seç)
o 1 – Pending (Bekliyor)
o 2 – Processing (Hazırlanıyor)
o 3 – Shipped (Sevk edildi)
Status (Integer) : Siparişin durumu
o 0 – OpenNew (Açık)
o 1 – ClosedFulfilled (Tamamlandı)
o 2 – Cancelled (İptal)
Description : Sipariş açıklaması
CustomStageId : Özel aşamanın Id’si
ParentProposalId : Sipariş bir teklife bağlı ise bağlı olduğu teklifinin Id’si
Tags (Array of String) : Etiketler
Name (String) : Siparişin adı
RelatedEntityId (Integer) : Siparişin müşteri Id’si
RelatodOpportunityId (Integer)
Items (Array of Object) : Sipariş detayları
o Product : Ürün
Id (Integer): Ürünün Id’si
o Quantity (Double) : Miktarı
o Price (Double) : Fiyatı
o CurrencyName (String) : Para birimi
o Description (String) : Açıklama
o Vat (Double?) : Kdv
o DiscountType (Integer) : Satırın indirim tipi
0 – PercentOff : Yüzde indirim
1 – AmountOff : Miktar indirimi
o Discount (Double) : Satırın indirim miktarı
o Unit (String) : Birimi
CustomFieldDatas (Array) : Özel alan veri listesi
o CustomFieldId (Integer) : Özel alan Id’si
o Value (String)
RelatedEntityIds (String)
Discount (Double?) : Siparişin İndirim miktarı
DiscountType (Integer) : Siparişin İndirim tipi
o 0 – PercentOff : Yüzde indirim
o 1 – AmountOff : Miktar indirimi
DiscountCurrencyName (String) : Eğer miktar indirimi ise indirimin para birimi
ReadersIdToString (Array of String) : Okuma izinleri
WritersIdToString (Array of String) : Yazma izinleri
OwnerId (Integer) : Siparişin sahibinin Id’si
VatType (Integer): Kdv kullanımı
o 0 – NoVat: Kdv yok
o 1 – VatExclusive: Kdv hariç
o 2 – VatInclusive: Kdv dahil
CustomerPhone (String)
TemplateId (Integer?)
CustomRates : Özel fiyatlar
o FromCurrencyName (String) : Hangi para biriminden
o ToCurrencyName (String): Hangi para birimine
o Rate (Double) : Oran
Response
Result (Boolean)
Id (Integer) : Siparişin Id’si
Görme
Bu metod ile unique Id’si belli bir siparişin tüm detaylarını görebilirsiniz.
URL
https://api.teamgram.com/v1/[ŞİRKETİSMİ]/Orders/Get
Request
Id (int)
Response
ClassName (String) : Cinsi (Party, Individual, Order etc.)
Description (String) : Açıklaması
CustomFieldDatas (Array) : Özel alan veri listesi
o Id (Integer)
o CustomFieldId (Integer) : Özel alan Id’si
o IsRequired (Boolean)
o RelatedEntity: Siparişin müşterisi
Id (Integer)
Name (String) : Müşterinin adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Müşterinin tam adı
TaxNo (String)
TaxOffice (String)
o ScanCode (Boolean)
o ListValues (Array of String)
o UnFormettedDate (String) : Formatsız tarih
o UnFormattedNumber (String) : Formatsız rakam
o CustomFieldName (String) : Özel alan adı
o CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Value (String)
o Values (String)
Items (Array of Object)
o Product : Ürün
Id (Integer): Ürünün Id’si
Name (String) : Ürünün adı
Brand (String) : Ürünün markası
ProdModel (String) : Ürünün modeli
Sku (String) : Ürünün müşteri tarafından belirlenen ürün kodu
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Ürünün tam adı
o Quantity (Double) : Miktarı
o Price (Double) : Birim Fiyatı
o LineTotal (Double) : Satır Toplamı
o CurrencyName (String) : Para birimi
o Description (String) : Açıklaması
o Vat (Double?) : Kdv
o DiscountType (Integer) : Satırın indirim tipi
0 – PercentOff : Yüzde indirim
1 – AmountOff : Miktar indirimi
o Discount (Double) : Satırın indirim miktarı
o Unit (String) : Birimi
DeliveryAddress (String) : Teslimat adresi
CustomerPhone (String)
BillingAddress (String) : Fatura adresi
IntroText (String): Siparişin giriş metni (HTML)
FooterText (String): Siparişin dip notları (HTML)
AccountingRelations (Array): Siparişin cari işlemleri
o EnteredDate (DateTime) : Cari işlemin giriş zamanı
o ModifiedDate (DateTime?) : Cari işlemin değiştirilme zamanı
o LastActivityDate (DateTime?): Cari işlemin son aktivite tarihi
o ReturnOfItemId (Integer): Bu cari işlemin hangi cari işlemin iadesi olduğu
o Returns (Array of Object): Bu cari işlem için yapılan iadeler
Account: Cari işlemin hesabı
Id (Integer)
Name (String) : Hesabın adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Hesabın tam adı
TaxNo (String)
TaxOffice (String)
Id (Integer)
Description (String): Açıklama
TransactionType (Integer): Cari işlemin tipi
0-Collection: Tahsilat
1-Payment: Ödeme
2-SalesInvoice: Satış faturası
3-ReturnOfSale: Satış iadesi
4-PurchaseInvoice: Alış faturası
5-ReturnOfPurchase: Alış iadesi
6-DebitNote: Borçlandırma
7-CreditNote: Alacaklandırma
PaymentMethod (Integer): Ödeme tipi
0-None: Yok
1-Cash: Nakit
2-Cheque: Çek
3-CreditCard: Kredi kartı
4-BankTransfer: Banka transferi
5-Bill: Senet
CurrencyName (String): Para birimi
Amount (Double): Miktar
DueDate (DateTime?): Vade tarihi
TransactionDate (DateTime): İşlem tarihi
OutstandingBalance (Double): Açıkta kalan balans
o Xtransactions (Hesap hareketleri)
Id (Integer)
Xamount (Double)
ItemId (Integer)
ItemOutstandingBalance (Double)
ItemTransactionDate (DateTime)
ItemTransactionType
0-Collection: Tahsilat
1-Payment: Ödeme
2-SalesInvoice: Satış faturası
3-ReturnOfSale: Satış iadesi
4-PurchaseInvoice: Alış faturası
5-ReturnOfPurchase: Alış iadesi
6-DebitNote: Borçlandırma
7-CreditNote: Alacaklandırma
ItemDueDate (DateTime?)
ItemDescription (String)
ItemAmount (Double)
ItemCurrencyName (String): Para birimi
o ModifiedBy : Değiştiren kişi
Id (Integer)
Name (String)
o EnteredBy : Giren kişi
Id (Integer)
Name (String)
o InvoiceNo (String) : Fatura no
o BelongsToOrder: Hangi siparişe ait bir işlem olduğu
ActualFulfilment (DateTime?) : Eğer var ise gerçekleşen teslim tarihi
ScheduledFulfilment (DateTime?) : Eğer var ise teslim tarihi
OrderDate (DateTime) : Sipariş tarihi
Stage (Integer) : Siparişin aşaması
0 – Choose (Seç)
1 – Pending (Bekliyor)
2 – Processing (Hazırlanıyor)
3 – Shipped (Sevk edildi)
Status (Integer) : Siparişin durumu
0 – OpenNew (Açık)
1 – ClosedFulfilled (Tamamlandı)
2 – Cancelled (İptal)
CustomStageName (String) : Eğer özelleştirilmiş aşama kullanılıyorsa, özel
aşamanın adı
CustomStageId (Integer) : Eğer özelleştirilmiş aşama kullanılıyorsa, özel
aşamanın Id’si
Id (Integer) : Siparişin Id’si
Name (String) : Siparişin konusu
Displayname (String) : Siparişin tam adı
CurrencyName : Para birimi
RelatedEntities (Array of Object) : Siparişin ilişkili olduğu diğer objeler
Id
Name
LastName
ClassName
RelatedEntity : Siparişin müşterisi
Id
Name
LastName
Displayname
TaxNo
TaxOffice
Owner : Siparişin sahibi
Id
Name
LastName
ClassName
Displayname
Tags (Array of String) : Etiketler
LastActivityDate (DateTime?) : Siparişin en son aktivite tarihi
EnteredDate (DateTime) : Siparişin oluşturulduğu tarih
ModifiedDate (DateTime?) : Siparişin en son değiştirildiği tarih
Discount (Double) : Siparişin indirim miktarı
DiscountType (Integer) : Siparişin indirim tipi
0 – PercentOff : Yüzde indirim
1 – AmountOff : Miktar indirimi
DiscountedTotal (Double) : Toplam indirim
ParentProposal : Eğer var ise siparişin teklifi
Id (Integer)
Name (String) : Siparişin adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Siparişin tam adı
DiscountCurrencyName (String) : Eğer miktar indirimi ise indirimin para
birimi
ModifiedBy : Değiştiren kişi
Id
Name
EnteredBy : Giren kişi
Id
Name
VatType (Integer): Kdv kullanımı
0 – NoVat: Kdv yok
1 – VatExclusive: Kdv hariç
2 – VatInclusive: Kdv dahil
AddedToAccounting (bool) : Cari hesaplara eklenmiş
MailSent (bool) : Bu sipariş için müşteriye mail gönderilmiş
CustomRates : Özel fiyatlar
FromCurrencyName (String) : Hangi para biriminden
ToCurrencyName (String): Hangi para birimine
Rate (Double) : Oran
o BelongsToPurchase: Hangi tedarikçi siparişine ait bir işlem olduğu
ActualFulfilment (Datetime?) : Eğer var ise gerçekleşen teslim tarihi
ScheduledFulfilment (DateTime?) : Eğer var ise teslim tarihi
OrderDate (DateTime) : Sipariş tarihi
Stage (Integer) : Siparişin aşaması
0 – Choose (Seç)
1 – Pending (Bekliyor)
2 – Processing (Hazırlanıyor)
3 – Shipped (Sevk edildi)
Status (Integer) : Siparişin durumu
0 – OpenNew (Açık)
1 – ClosedFulfilled (Tamamlandı)
2 – Cancelled (İptal)
CustomStageName (String) : Eğer özelleştirilmiş aşama kullanılıyorsa, özel
aşamanın adı
CustomStageId (Integer) : Eğer özelleştirilmiş aşama kullanılıyorsa, özel
aşamanın Id’si
Id (Integer) : Siparişin Id’si
Name (String) : Siparişin konusu
Displayname (String) : Siparişin tam adı
CurrencyName : Para birimi
RelatedEntities (Array of Object) : Siparişin ilişkili olduğu diğer objeler
Id
Name
LastName
ClassName
RelatedEntity : Siparişin müşterisi
Id
Name
LastName
Displayname
TaxNo
TaxOffice
Owner : Siparişin sahibi
Id
Name
LastName
ClassName
Displayname
Tags (Array of String) : Etiketler
LastActivityDate (DateTime?) : Siparişin en son aktivite tarihi
EnteredDate (DateTime) : Siparişin oluşturulduğu tarih
ModifiedDate (DateTime?) : Siparişin en son değiştirildiği tarih
Discount (Double) : Siparişin indirim miktarı
DiscountType (Integer) : Siparişin indirim tipi
0 – PercentOff : Yüzde indirim
1 – AmountOff : Miktar indirimi
DiscountedTotal (Double) : Toplam indirim
ParentProposal : Eğer var ise siparişin teklifi
Id
Name
ClassName
Displayname
DiscountCurrencyName (String) : Eğer miktar indirimi ise indirimin para
birimi
ModifiedBy : Değiştiren kişi
Id
Name
Controller
Own
ProfilePictureFileKey
EnteredBy : Oluşturan kişi
Id
Name
VatType (Integer): Kdv kullanımı
0 – NoVat: Kdv yok
1 – VatExclusive: Kdv hariç
2 – VatInclusive: Kdv dahil
AddedToAccounting (bool) : Cari hesaplara eklenmiş
MailSent (bool) : Bu sipariş için müşteriye mail gönderilmiş
CustomRates : Özel fiyatlar
FromCurrencyName (String) : Hangi para biriminden
ToCurrencyName (String): Hangi para birimine
Rate (Double) : Oran
ActualFulfilment (Datetime?) : Eğer var ise gerçekleşen teslim tarihi
ScheduledFulfilment (DateTime?) : Eğer var ise teslim tarihi
OrderDate (DateTime) : Sipariş tarihi
Stage (Integer) : Siparişin aşaması
o 0 – Choose (Seç)
o 1 – Pending (Bekliyor)
o 2 – Processing (Hazırlanıyor)
o 3 – Shipped (Sevk edildi)
Status (Integer) : Siparişin durumu
o 0 – OpenNew (Açık)
o 1 – ClosedFulfilled (Tamamlandı)
o 2 – Cancelled (İptal)
CustomStageName (String) : Özel aşamanın adı
CustomStageId (Integer) : Özel aşamanın Id’si
Id (Integer) : Siparişin Id’si
Name (String) : Siparişin konusu
Displayname (String) : Siparişin tam adı
CurrencyName : Para birimi
RelatedEntities (Array of Object) : Siparişin ilişkili olduğu diğer objeler
o Id
o Name
o ClassName
o Displayname
RelatedEntity : Siparişin müşterisi
o Id
o Name
o LastName
o ClassName
o Displayname
o TaxNo
o TaxOffice
Owner : Siparişin sahibi
o Id
o Name
o LastName
o ClassName
o Displayname
Tags (Array of String) : Etiketler
LastActivityDate (DateTime?) : Siparişin en son aktivite tarihi
EnteredDate (DateTime) : Siparişin oluşturulduğu tarih
ModifiedDate (DateTime?) : Siparişin en son değiştirildiği tarih
Discount (Double) : Siparişin indirim miktarı
DiscountType (Integer) : Siparişin indirim tipi
o 0 – PercentOff : Yüzde indirim
o 1 – AmountOff : Miktar indirimi
DiscountedTotal (Double) : Toplam indirim
ParentProposal : Eğer var ise siparişin teklifi
o Id
o Name
o ClassName
o Displayname
DiscountCurrencyName (String) : Eğer miktar indirimi ise indirimin para birimi
ModifiedBy : Değiştiren kişi
o Id
o Name
EnteredBy : Giren kişi
o Id
o Name
VatType (Integer): Kdv kullanımı
o 0 – NoVat: Kdv yok
o 1 – VatExclusive: Kdv hariç
o 2 – VatInclusive: Kdv dahil
AddedToAccounting (bool) : Cari hespalara eklenmiş
MailSent (bool) : Bu sipariş için müşteriye mail gönderilmiş
CustomRates : Özel fiyatlar
o FromCurrencyName (String) : Hangi para biriminden
o ToCurrencyName (String): Hangi para birimine
o Rate (Double) : Oran
URL
https://api.teamgram.com/v1/[ŞİRKETİSMİ]/Orders/GetLastID
Response
Id (Integer): Sipariş Id’si. Eğer sipariş yok ise ‘0’ döner.
LastEnumeration (String): Son teklif sayısı. Eğer teklif yok ise ‘0’ döner.
Silme
Bu metod ile siparişi Id vererek silebilirsiniz.
URL
POST https://api.teamgram.com/[ŞİRKETİSMİ]/Orders/Delete
Request
Id (Integer)
Response
Result: (Boolean)
Errors
404 – Order not found
404 – No access
Çoklu Silme
Bu metod ile Siparişlerin Id’lerini, dizi nesnesi vererek çoklu silebilirsiniz.
URL
https://api.teamgram.com/[ŞİRKETİSMİ]/Orders/DeleteMultiple
Request
ids (Array of Integer) : Silinecek siparişlerin Id’leri
Response
Result: (Boolean)
Errors
404 – Order not found
404 – No access
Durum güncelleme
Bir siparişin durumunu günceller.
URL
POST https://api.teamgram.com/v1/[ŞİRKETİSMİ]/Orders/UpdateStatus
Request
Id (int) Sipariş Id’si
status (Integer) : Siparişin durumu
o 0 – OpenNew (Açık)
o 1 – ClosedFulfilled (Tamamlandı)
o 2 – Cancelled (İptal)
Stage (Integer) : Siparişin aşaması
o 0 – Choose (Seç)
o 1 – Pending (Bekliyor)
o 2 – Processing (Hazırlanıyor)
o 3 – Shipped (Sevk edildi)
actualFulfilmentDate(DateTime?) : Gerçekleşen teslim tarihi
Response
Result (Boolean)
Id (Integer) : Siparişin Id’si
AddedToAccounting (Boolean) : Cari hespalara eklenmiş
Errors
404 – Order not found
404 – No access
Durum logları
Bir siparişin yapılan durum güncellemelerinin loglarını getirir.
URL
POST https://api.teamgram.com/v1/[ŞİRKETİSMİ]/Orders/StatusLog
Request
Id (int) Sipariş Id’si
Response
Indate (DateTime) : Güncellemenin yapıldığı tarih
Who (Integer) : Güncellemeyi yapan kişi
Status (Integer) : Siparişin durumu
o 0 – OpenNew (Açık)
o 1 – ClosedFulfilled (Tamamlandı)
o 2 – Cancelled (İptal)
Stage (Integer) : Siparişin aşaması
o 0 – Choose (Seç)
o 1 – Pending (Bekliyor)
o 2 – Processing (Hazırlanıyor)
o 3 – Shipped (Sevk edildi)
Tedarikçi Sipariş
Listeleme
Bu metod, siparişleri sayfa sayfa almaya yarar ancak siparişlerin tüm detayları gelmez. Vereceği
veriler için bazı filtre özellikleri mevcuttur.
URL
https://api.teamgram.com/[ŞİRKETİSMİ]/Purchases/Index
Request
page (Integer: default:1)
pagesize (Integer: default:20)
ofid (Integer: default:0) : Bir objenin siparişleri. (Örneğin: Bir ürün Id’si veya bir şirket
Id’si)
own (Boolean: default:false)
fid (Integer?: default:null)
o 0: Açık siparişler (Sipariş tarihi sıralı)
o -1: Kapanan siparişler
o -2: Açık siparişler (Tamamlanma tarihi sıralı)
o -3: Açık siparişler (No. sıralı)
o N: Bu kullanıcı için tanımlanmış bir filtrenin Id’si (TeamGram arayüzünden
tanımlanabilir)
Response
Filters (Array of Object)
o Name (String) : Filtrenin adı
o Id (Integer) : Filtrenin Id’si
List (Array of Object)
o ActualFulfilment (Datetime?) : Eğer var ise gerçekleşen teslim tarihi
o ScheduledFulfilment (DateTime?) : Eğer var ise teslim tarihi
o OrderDate (DateTime) : Sipariş tarihi
o Stage (Integer) : Siparişin aşaması
0 – Choose (Seçenek)
1 – Pending (Bekliyor)
2 – Processing (Hazırlanıyor)
3 – Shipped (Sevk edildi)
o Status (Integer) : Siparişin durumu
0 – OpenRequested (Talep edildi)
1 – ClosedReceived (Teslim alındı)
2 – Cancelled (İptal)
o CustomStageName (String) : Eğer özelleştirilmiş aşama kullanılıyorsa, özel
aşamanın adı
o CustomStageId (Integer) : Eğer özelleştirilmiş aşama kullanılıyorsa, özel aşamanın
Id’si
o Id (Integer) : Siparişin Id’si
o Name (String) : Siparişin adı
o Displayname (String) : Siparişin uzun adı
o CurrencyName (String) : Kullanılan para biriminin adı
o RelatedEntities (Array of Object) : Siparişin ilişkili olduğu diğer objeler
Id (Integer)
Displayname (String) : Adı
ClassName (String) : Cinsi (Party, Individual etc.)
o RelatedEntity: Siparişin tedarikçisi
Id (Integer)
Displayname (String) : Adı
ClassName (String) : Cinsi (Party, Individual etc.)
o Owner : Siparişin sahibi
Id (Integer)
Displayname (String) : Adı
ClassName (String) : Cinsi (Party, Individual etc.)
o Tags (Array of String) : Etiketler
o LastActivityDate (DateTime?) : Siparişin en son aktivite tarihi
o EnteredDate (DateTime) : Siparişin oluşturulduğu tarih
o ModifiedDate (DateTime?) : Siparişin en son değiştirildiği tarih
o DiscountType (Integer) : Siparişin indirim tipi
0 – PercentOff : Yüzde indirim
1 – AmountOff : Miktar indirimi
o Discount (Double) : Siparişin indirim miktarı
o DiscountCurrencyName (String) : Eğer miktar indirimi ise indirimin para birimi
o ParentProposal : Eğer var ise siparişin teklifi
Id (Integer)
Name (String) : Siparişin adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Siparişin tam adı
o ModifiedBy : Siparişi en son değiştiren
Id (Integer)
Name (String) : Kişinin adı
o EnteredBy: Siparişi oluşturan
Id (Integer)
Name (String) : Kişinin adı
o VatType (Integer): Kdv kullanımı
0 – NoVat : Kdv yok
1 – VatExclusive : Kdv hariç
2 – VatInclusive : Kdv dahil
o AddedToAccounting (Boolean) : Cari hesaplara eklenmiş
o MailSent (Boolean) : Bu sipariş için müşteriye mail gönderilmiş
o CustomRates : Kullanılan kurlar
FromCurrencyName (String) : Hangi para biriminden
ToCurrencyName (String): Hangi para birimine
Rate (Double) : Oran
CustomFields (Array of Object)
o Id (Integer)
o Name (String) : Özel alan adı
o EntityType (String) : “Party”
o Type (Integer)
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Required (Boolean)
o PropertiesPulldownStrings (String Array) : Pulldown tipli alanların içeriği
o Order (Integer) : Gösterilme sırası
PurchaseCount (Integer) : Dönen sipariş adedi
URL
GET https://api.teamgram.com/[ŞİRKETİSMİ]/Purchases/GetNew
Request
Id (Integer)
page (Integer: default:1)
pagesize (Integer: default:20)
Response
count (Integer)
page (Integer)
pageSize (Integer)
Oluşturma
Bu metod ile yeni bir sipariş oluşturabilirsiniz.
URL
POST https://api.teamgram.com/[ŞİRKETİSMİ]/Purchases/Create
Request
OrderDate (Datetime) : Sipariş Tarihi
ScheduledFulfilment (DateTime?) : Eğer var ise teslim tarihi
DeliveryAddress (String) : Teslimat adresi
BillingAddress (String) : Fatura Adersi
Stage (Integer) : Siparişin aşaması
o 0 – Choose (Seçenek)
o 1 – Pending (Bekliyor)
o 2 – Processing (Hazırlanıyor)
o 3 – Shipped (Sevk edildi)
Status (Integer) : Siparişin durumu
o 0 – OpenRequested (Talep edildi)
o 1 – ClosedReceived (Teslim alındı)
o 2 – Cancelled (İptal)
Description : Sipariş açıklaması
CustomStageId : Eğer özel aşamalar kullanılıyorsa özel aşamanın Id’si
CustomStageName : Sipariş özel aşamasının adı
Tags (Array of String) : Etiketler
Name (String) : Sipariş adı
RelatedEntityId (Integer) : Siparişin müşteri Id’si
RelatodOpportunityId (Integer)
Items (Array of Object) : Siparişin detayları
o Product : Ürün
Id (Integer): Ürünün Id’si
o Quantity (Double) : Miktarı
o Price (Double) : Fiyatı
o CurrencyName (String) : Para birimi
o Description (String) : Açıklama
o Vat (Double?) : Kdv
o DiscountType (Integer) : Satırın indirim tipi
0 – PercentOff : Yüzde indirim
1 – AmountOff : Miktar indirimi
o Discount (Double) : Satırın indirim miktarı
o Unit (String) : Birimi
CustomFieldDatas (Array) : Özel alan veri listesi
o CustomFieldId (Integer) : Özel alan Id’si
o Value (String)
RelatedEntityIds (String)
Discount (Double?) : Siparişin İndirim miktarı
DiscountType (Integer) : Siparişin İndirim tipi
o 0 – PercentOff : Yüzde indirim
o 1 – AmountOff : Miktar indirimi
DiscountCurrencyName (String) : Eğer miktar indirimi ise indirimin para birimi
OwnerId (Integer) : Siparişin sahibinin Id’si
VatType (Integer): Kdv kullanımı
o 0 – NoVat: Kdv yok
o 1 – VatExclusive: Kdv hariç
o 2 – VatInclusive: Kdv dahil
CustomerPhone (String)
TemplateId (Integer?)
CustomRates : Özel fiyatlar
o FromCurrencyName (String) : Hangi para biriminden
o ToCurrencyName (String): Hangi para birimine
o Rate (Double) : Oran
Response
Result (Boolean)
Id (Integer) : Siparişin Id’si
Message (String) : Hata mesajını temsil eder
MessageCode (Integer) : Hatanın kodu
o NULL: No error
o 0: GeneralError
o 1: EntityLimitExceeded
o 2: MaxStorageExceeded
o 3: MaxFileSizeExceeded
o 4: MonthlyMaxFilesExceeded
o 5: CreateRestriction
o 6: RequiredDataMissing
Değiştirme
Bu metod gelen modeli kaydeder.
URL
POST https://api.teamgram.com/[ŞİRKETİSMİ]/Purchases/Edit
Request
Id (Integer)
OrderDate (Datetime) : Sipariş Tarihi
ScheduledFulfilment (DateTime?) : Eğer var ise teslim tarihi
DeliveryAddress (String) : Teslimat adresi
BillingAddress (String) : Fatura Adersi
Stage (Integer) : Siparişin aşaması
o 0 – Choose (Seçenek)
o 1 – Pending (Bekliyor)
o 2 – Processing (Hazırlanıyor)
o 3 – Shipped (Sevk edildi)
Status (Integer) : Siparişin durumu
o 0 – OpenRequested (Talep edildi)
o 1 – ClosedReceived (Teslim alındı)
o 2 – Cancelled (İptal)
Description : Sipariş açıklaması
CustomStageId : Eğer özel aşamalar kullanılıyorsa özel aşamanın Id’si
CustomStageName : Sipariş özel aşamasının adı
Tags (Array of String) : Etiketler
Name (String) : Sipariş adı
RelatedEntityId (Integer) : Siparişin müşteri Id’si
RelatodOpportunityId (Integer)
Items (Array of Object) : Siparişin detayları
o Product : Ürün
Id (Integer): Ürünün Id’si
o Quantity (Double) : Miktarı
o Price (Double) : Fiyatı
o CurrencyName (String) : Para birimi
o Description (String) : Açıklama
o Vat (Double?) : Kdv
o DiscountType (Integer) : Satırın indirim tipi
0 – PercentOff : Yüzde indirim
1 – AmountOff : Miktar indirimi
o Discount (Double) : Satırın indirim miktarı
o Unit (String) : Birimi
CustomFieldDatas (Array) : Özel alan veri listesi
o CustomFieldId (Integer) : Özel alan Id’si
o Value (String)
RelatedEntityIds (String)
Discount (Double?) : Siparişin İndirim miktarı
DiscountType (Integer) : Siparişin İndirim tipi
o 0 – PercentOff : Yüzde indirim
o 1 – AmountOff : Miktar indirimi
DiscountCurrencyName (String) : Eğer miktar indirimi ise indirimin para birimi
OwnerId (Integer) : Siparişin sahibinin Id’si
VatType (Integer): Kdv kullanımı
o 0 – NoVat: Kdv yok
o 1 – VatExclusive: Kdv hariç
o 2 – VatInclusive: Kdv dahil
CustomerPhone (String)
TemplateId (Integer?)
CustomRates : Özel fiyatlar
o FromCurrencyName (String) : Hangi para biriminden
o ToCurrencyName (String): Hangi para birimine
o Rate (Double) : Oran
Response
Result (Boolean)
Id (Integer) : Siparişin Id’si
Görme
Bu metod ile unique Id’si belli bir siparişin tüm detaylarını görebilirsiniz.
URL
https://api.teamgram.com/[ŞİRKETİSMİ]/Purchases/Get
Request
Id (int)
Response
ClassName (String) : Cinsi (Party, Individual, Order etc.)
Description (String) : Açıklaması
CustomFieldDatas (Array) : Özel alan veri listesi
o Id (Integer)
o CustomFieldId (Integer) : Özel alan Id’si
o IsRequired (Boolean)
o RelatedEntity: Siparişin müşterisi
Id (Integer)
Name (String) : Müşterinin adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Müşterinin tam adı
TaxNo (String)
TaxOffice (String)
o ScanCode (Boolean)
o ListValues (Array of String)
o UnFormettedDate (String) : Formatsız tarih
o UnFormattedNumber (String) : Formatsız rakam
o CustomFieldName (String) : Özel alan adı
o CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Value (String)
o Values (String)
Items (Array of Object)
o Product : Ürün
Id (Integer): Ürünün Id’si
Name (String) : Ürünün adı
Brand (String) : Ürünün markası
ProdModel (String) : Ürünün modeli
Sku (String) : Ürünün müşteri tarafından belirlenen ürün kodu
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Ürünün tam adı
o Quantity (Double) : Miktarı
o Price (Double) : Birim Fiyatı
o LineTotal (Double) : Satır Toplamı
o CurrencyName (String) : Para birimi
o Description (String) : Açıklaması
o Vat (Double?) : Kdv
o DiscountType (Integer) : Satırın indirim tipi
0 – PercentOff : Yüzde indirim
1 – AmountOff : Miktar indirimi
o Discount (Double) : Satırın indirim miktarı
o Unit (String) : Birimi
DeliveryAddress (String) : Teslimat adresi
CustomerPhone (String)
BillingAddress (String) : Fatura adresi
IntroText (String): Siparişin giriş metni (HTML)
FooterText (String): Siparişin dip notları (HTML)
AccountingRelations (Array): Siparişin cari işlemleri
o EnteredDate (DateTime) : Cari işlemin giriş zamanı
o ModifiedDate (DateTime?) : Cari işlemin değiştirilme zamanı
o LastActivityDate (DateTime?): Cari işlemin son aktivite tarihi
o ReturnOfItemId (Integer): Bu cari işlemin hangi cari işlemin iadesi olduğu
o Returns (Array of Object): Bu cari işlem için yapılan iadeler
Account: Cari işlemin hesabı
Id (Integer)
Name (String) : Hesabın adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Hesabın tam adı
TaxNo (String)
TaxOffice (String)
Id (Integer)
Description (String): Açıklama
TransactionType (Integer): Cari işlemin tipi
0-Collection: Tahsilat
1-Payment: Ödeme
2-SalesInvoice: Satış faturası
3-ReturnOfSale: Satış iadesi
4-PurchaseInvoice: Alış faturası
5-ReturnOfPurchase: Alış iadesi
6-DebitNote: Borçlandırma
7-CreditNote: Alacaklandırma
PaymentMethod (Integer): Ödeme tipi
0-None: Yok
1-Cash: Nakit
2-Cheque: Çek
3-CreditCard: Kredi kartı
4-BankTransfer: Banka transferi
5-Bill: Senet
CurrencyName (String): Para birimi
Amount (Double): Miktar
DueDate (DateTime?): Vade tarihi
TransactionDate (DateTime): İşlem tarihi
OutstandingBalance (Double): Açıkta kalan balans
o Xtransactions (Hesap hareketleri)
Id (Integer)
Xamount (Double)
ItemId (Integer)
ItemOutstandingBalance (Double)
ItemTransactionDate (DateTime)
ItemTransactionType
0-Collection: Tahsilat
1-Payment: Ödeme
2-SalesInvoice: Satış faturası
3-ReturnOfSale: Satış iadesi
4-PurchaseInvoice: Alış faturası
5-ReturnOfPurchase: Alış iadesi
6-DebitNote: Borçlandırma
7-CreditNote: Alacaklandırma
ItemDueDate (DateTime?)
ItemDescription (String)
ItemAmount (Double)
ItemCurrencyName (String): Para birimi
o ModifiedBy : Değiştiren kişi
Id (Integer)
Name (String)
o EnteredBy : Giren kişi
Id (Integer)
Name (String)
o InvoiceNo (String) : Fatura no
o BelongsToOrder: Hangi siparişe ait bir işlem olduğu
ActualFulfilment (DateTime?) : Eğer var ise gerçekleşen teslim tarihi
ScheduledFulfilment (DateTime?) : Eğer var ise teslim tarihi
OrderDate (DateTime) : Sipariş tarihi
Stage (Integer) : Siparişin aşaması
0 – Choose (Seç)
1 – Pending (Bekliyor)
2 – Processing (Hazırlanıyor)
3 – Shipped (Sevk edildi)
Status (Integer) : Siparişin durumu
0 – OpenNew (Açık)
1 – ClosedFulfilled (Tamamlandı)
2 – Cancelled (İptal)
CustomStageName (String) : Eğer özelleştirilmiş aşama kullanılıyorsa, özel
aşamanın adı
CustomStageId (Integer) : Eğer özelleştirilmiş aşama kullanılıyorsa, özel
aşamanın Id’si
Id (Integer) : Siparişin Id’si
Name (String) : Siparişin konusu
Displayname (String) : Siparişin tam adı
CurrencyName : Para birimi
RelatedEntities (Array of Object) : Siparişin ilişkili olduğu diğer objeler
Id
Name
LastName
ClassName
RelatedEntity : Siparişin müşterisi
Id
Name
LastName
Displayname
TaxNo
TaxOffice
Owner : Siparişin sahibi
Id
Name
LastName
ClassName
Displayname
Tags (Array of String) : Etiketler
LastActivityDate (DateTime?) : Siparişin en son aktivite tarihi
EnteredDate (DateTime) : Siparişin oluşturulduğu tarih
ModifiedDate (DateTime?) : Siparişin en son değiştirildiği tarih
Discount (Double) : Siparişin indirim miktarı
DiscountType (Integer) : Siparişin indirim tipi
0 – PercentOff : Yüzde indirim
1 – AmountOff : Miktar indirimi
DiscountedTotal (Double) : Toplam indirim
ParentProposal : Eğer var ise siparişin teklifi
Id (Integer)
Name (String) : Siparişin adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Siparişin tam adı
DiscountCurrencyName (String) : Eğer miktar indirimi ise indirimin para
birimi
ModifiedBy : Değiştiren kişi
Id
Name
EnteredBy : Giren kişi
Id
Name
VatType (Integer): Kdv kullanımı
0 – NoVat: Kdv yok
1 – VatExclusive: Kdv hariç
2 – VatInclusive: Kdv dahil
AddedToAccounting (bool) : Cari hesaplara eklenmiş
MailSent (bool) : Bu sipariş için müşteriye mail gönderilmiş
CustomRates : Özel fiyatlar
FromCurrencyName (String) : Hangi para biriminden
ToCurrencyName (String): Hangi para birimine
Rate (Double) : Oran
o BelongsToPurchase: Hangi tedarikçi siparişine ait bir işlem olduğu
ActualFulfilment (Datetime?) : Eğer var ise gerçekleşen teslim tarihi
ScheduledFulfilment (DateTime?) : Eğer var ise teslim tarihi
OrderDate (DateTime) : Sipariş tarihi
Stage (Integer) : Siparişin aşaması
0 – Choose (Seç)
1 – Pending (Bekliyor)
2 – Processing (Hazırlanıyor)
3 – Shipped (Sevk edildi)
Status (Integer) : Siparişin durumu
0 – OpenNew (Açık)
1 – ClosedFulfilled (Tamamlandı)
2 – Cancelled (İptal)
CustomStageName (String) : Eğer özelleştirilmiş aşama kullanılıyorsa, özel
aşamanın adı
CustomStageId (Integer) : Eğer özelleştirilmiş aşama kullanılıyorsa, özel
aşamanın Id’si
Id (Integer) : Siparişin Id’si
Name (String) : Siparişin konusu
Displayname (String) : Siparişin tam adı
CurrencyName : Para birimi
RelatedEntities (Array of Object) : Siparişin ilişkili olduğu diğer objeler
Id
Name
LastName
ClassName
RelatedEntity : Siparişin müşterisi
Id
Name
LastName
Displayname
TaxNo
TaxOffice
Owner : Siparişin sahibi
Id
Name
LastName
ClassName
Displayname
Tags (Array of String) : Etiketler
LastActivityDate (DateTime?) : Siparişin en son aktivite tarihi
EnteredDate (DateTime) : Siparişin oluşturulduğu tarih
ModifiedDate (DateTime?) : Siparişin en son değiştirildiği tarih
Discount (Double) : Siparişin indirim miktarı
DiscountType (Integer) : Siparişin indirim tipi
0 – PercentOff : Yüzde indirim
1 – AmountOff : Miktar indirimi
DiscountedTotal (Double) : Toplam indirim
ParentProposal : Eğer var ise siparişin teklifi
Id
Name
ClassName
Displayname
DiscountCurrencyName (String) : Eğer miktar indirimi ise indirimin para
birimi
ModifiedBy : Değiştiren kişi
Id
Name
Controller
Own
ProfilePictureFileKey
EnteredBy : Oluşturan kişi
Id
Name
VatType (Integer): Kdv kullanımı
0 – NoVat: Kdv yok
1 – VatExclusive: Kdv hariç
2 – VatInclusive: Kdv dahil
AddedToAccounting (bool) : Cari hesaplara eklenmiş
MailSent (bool) : Bu sipariş için müşteriye mail gönderilmiş
CustomRates : Özel fiyatlar
FromCurrencyName (String) : Hangi para biriminden
ToCurrencyName (String): Hangi para birimine
Rate (Double) : Oran
ActualFulfilment (Datetime?) : Eğer var ise gerçekleşen teslim tarihi
ScheduledFulfilment (DateTime?) : Eğer var ise teslim tarihi
OrderDate (DateTime) : Sipariş tarihi
Stage (Integer) : Siparişin aşaması
o 0 – Choose (Seçenek)
o 1 – Pending (Bekliyor)
o 2 – Processing (Hazırlanıyor)
o 3 – Shipped (Sevk edildi)
Status (Integer) : Siparişin durumu
o 0 – OpenRequested (Talep edildi)
o 1 – ClosedReceived (Teslim alındı)
o 2 – Cancelled (İptal)
CustomStageName (String) : Özel aşamanın adı
CustomStageId (Integer) : Özel aşamanın Id’si
Id (Integer) : Siparişin Id’si
Name (String) : Siparişin konusu
Displayname (String) : Siparişin tam adı
CurrencyName : Para birimi
RelatedEntities (Array of Object) : Siparişin ilişkili olduğu diğer objeler
o Id
o Name
o ClassName
o Displayname
RelatedEntity : Siparişin müşterisi
o Id
o Name
o LastName
o ClassName
o Displayname
o TaxNo
o TaxOffice
Owner : Siparişin sahibi
o Id
o Name
o LastName
o ClassName
o Displayname
Tags (Array of String) : Etiketler
LastActivityDate (DateTime?) : Siparişin en son aktivite tarihi
EnteredDate (DateTime) : Siparişin oluşturulduğu tarih
ModifiedDate (DateTime?) : Siparişin en son değiştirildiği tarih
Discount (Double) : Siparişin indirim miktarı
DiscountType (Integer) : Siparişin indirim tipi
o 0 – PercentOff : Yüzde indirim
o 1 – AmountOff : Miktar indirimi
DiscountedTotal (Double) : Toplam indirim
ParentProposal : Eğer var ise siparişin teklifi
o Id
o Name
o ClassName
o Displayname
DiscountCurrencyName (String) : Eğer miktar indirimi ise indirimin para birimi
ModifiedBy : Değiştiren kişi
o Id
o Name
EnteredBy : Giren kişi
o Id
o Name
VatType (Integer): Kdv kullanımı
o 0 – NoVat: Kdv yok
o 1 – VatExclusive: Kdv hariç
o 2 – VatInclusive: Kdv dahil
AddedToAccounting (bool) : Cari hespalara eklenmiş
MailSent (bool) : Bu sipariş için müşteriye mail gönderilmiş
CustomRates : Özel fiyatlar
o FromCurrencyName (String) : Hangi para biriminden
o ToCurrencyName (String): Hangi para birimine
o Rate (Double) : Oran
URL
https://api.teamgram.com/[ŞİRKETİSMİ]/Purchases/GetLastID
Response
Id (Integer): Sipariş Id’si. Eğer sipariş yok ise ‘0’ döner.
LastEnumeration (String): Son sipariş sayısı. Eğer sipariş yok ise ‘0’ döner.
Silme
Bu metod ile siparişi Id vererek silebilirsiniz.
URL
POST https://api.teamgram.com/[ŞİRKETİSMİ]/Purchases/Delete
Request
Id (Integer)
Response
Result: (Boolean)
Message (String) : Silinen siparişin Id’si
Durum güncelleme
Bir siparişin durumunu günceller.
URL
POST https://api.teamgram.com/[ŞİRKETİSMİ]/Purchases/UpdateStatus
Request
Id (int) : Sipariş Id’si
Stage (Integer) : Siparişin aşaması
o 0 – Choose (Seçenek)
o 1 – Pending (Bekliyor)
o 2 – Processing (Hazırlanıyor)
o 3 – Shipped (Sevk edildi)
Status (Integer) : Siparişin durumu
o 0 – OpenRequested (Talep edildi)
o 1 – ClosedReceived (Teslim alındı)
o 2 – Cancelled (İptal)
actualFulfilmentDate(DateTime?) : Gerçekleşen teslim tarihi
Response
Result (Boolean)
Id (Integer) : Siparişin Id’si
AddedToAccounting (Boolean) : Cari hespalara eklenmiş
Durum logları
Bir siparişin, yapılan durum güncellemelerinin loglarını getirir.
URL
POST https://api.teamgram.com/[ŞİRKETİSMİ]/Purchases/StatusLog
Request
Id (int) Sipariş Id’si
Response
Indate (DateTime) : Güncellemenin yapıldığı tarih
Who (Integer) : Güncellemeyi yapan kişi
Status (Integer) : Siparişin durumu
o 0 – OpenNew (Açık)
o 1 – ClosedFulfilled (Tamamlandı)
o 2 – Cancelled (İptal)
Stage (Integer) : Siparişin aşaması
o 0 – Choose (Seç)
o 1 – Pending (Bekliyor)
o 2 – Processing (Hazırlanıyor)
o 3 – Shipped (Sevk edildi)
Teklifler
Listeleme
Bu metod, teklifleri sayfa sayfa almaya yarar ancak tekliflerin tüm detayları gelmez. Vereceği veriler
için bazı filtre özellikleri mevcuttur.
URL
https://api.teamgram.com/[ŞİRKETİSMİ]/Proposals/Index
Request
page (Integer: default:1)
pagesize (Integer: default:20)
ofid (Integer: default:0)
own (Boolean: default:false)
fid (Integer?: default:null)
Response
Filters (Array)
o Name : Teklifin adı
o Id
List : Tekliflerin listesi
o Stage : Teklifin aşaması
0 – Draft
1 – Submitted
2 – RevisionRequested
3 – Rejected
4 – Accepted
5 – Abandoned
6 – Withdrawn
7 – Revised
8 - Waiting
o SubmitDate (DateTime?)
o StageChangeDate (DateTime?) : Değiştirme zamanı
o SubmittedBy : Oluşturan kişi
Id (Integer)
Name (String)
LastName (String)
ClassName (String)
TaxNo (String)
TaxOffice (String)
o Attn : Firmanın detayları
Id (Integer)
Name (String)
LastName (String)
ClassName (String)
TaxNo (String)
TaxOffice (String)
o Id (Integer) : Teklifin Id’si
o Name (String) : Teklifin adı
o Displayname (String) : Teklifin tam adı
o CurrencyName (String) : Teklifin için kullanılan para biriminin adı
o RelatedEntities (Array of Object) :Teklifin ilişkili olduğu diğer objeler
Id (Integer)
Displayname (String) : Adı
ClassName (String) : Cinsi (Party, Individual etc.)
o RelatedEntity: Siparişin müşterisi
Id (Integer)
Displayname (String) : Adı
ClassName (String) : Cinsi (Party, Individual etc.)
o Owner : Siparişin sahibi
Id (Integer)
Displayname (String) : Adı
ClassName (String) : Cinsi (Party, Individual etc.)
o Tags (Array of String) : Etiketler
o LastActivityDate (DateTime?) : Teklifin en son aktivite tarihi
o EnteredDate (DateTime) : Teklifin oluşturulduğu tarih
o ModifiedDate (DateTime?) : Teklifin en son değiştirildiği tarih
o DiscountType (Integer) : Teklifin indirim tipi
0 – PercentOff : Yüzde indirim
1 – AmountOff : Miktar indirimi
o Discount (Double) : Teklifin indirim miktarı
o DiscountCurrencyName (String) : Eğer miktar indirimi ise indirimin para birimi
o Color (String)
o ParentProposal : Eğer var ise teklifin teklifi
Id (Integer)
Name (String) : Teklifin adı
LastName (String)
Brand (String) : Teklifin markası
ProdModel (String) : Teklifin modeli
Sku (String) : Teklifin müşteri tarafından belirlenen ürün kodu
ClassName (String) : Cinsi (Party, Individual etc.)
Type (String) : Tipi
Own (Boolean)
Displayname (String) :Teklifin tam adı
Email (String)
UiInfo (String)
TaxNo (String)
TaxOffice (String)
o ModifiedBy : Teklifin en son değiştiren
Id (Integer)
Name (String) : Teklifin adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
o EnteredBy: Siparişi oluşturan
Id (Integer)
Name (String) : Teklifin adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
o NoTotal (Boolean)
o VatType (Integer): Kdv kullanımı
0 – NoVat : Kdv yok
1 – VatExclusive : Kdv hariç
2 – VatInclusive : Kdv dahil
o AddedToAccounting (Boolean) : Cari hespalara eklenmiş
o MailSent (Boolean) : Bu teklifin için müşteriye mail gönderilmiş
o CustomRates : Özel fiyatlar
FromCurrencyName (String) : Hangi para biriminden
ToCurrencyName (String): Hangi para birimine
Rate (Double) : Oran
CustomFields : (Array of Object)
o Id (Integer)
o Name (String) : Özel alan adı
o EntityType (String) : “Party”
o Type (Integer)
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Required (Boolean)
o PropertiesPulldownStrings (String Array) : Pulldown tipli alanların içeriği
o Order (Integer) : Gösterilme sırası
ProposalCount (Integer)
Görme
Bu metod, istenilelen teklifi getirir.
URL
https://api.teamgram.com/[ŞİRKETİSMİ]/Proposals/Get
Request
Id (Integer)
Response
ClassName : Bulunduğu sınıfın adı
CustomFieldDatas (Array) : Özel alan veri listesi
o Id (Integer)
o CustomFieldId (Integer)
o IsRequired (Boolean)
o RelatedEntity : Teklifin müşterisi
Id (Integer)
Name (String) : Adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
TaxNo (String)
TaxOffice (String)
o ScanCode (Boolean)
o ListValues (Array of String)
o UnFormettedDate (String) : Formatsız tarih
o UnFormattedNumber (String) : Formatsız rakam
o CustomFieldName (String)
o CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Value (String)
o Values (String)
Items
o Product : Ürünün
Id (Integer): Ürünün Id’si
Name (String) : Ürünün adı
Brand (String) : Ürünün markası
ProdModel (String) : Ürünün modeli
Sku (String) : Ürünün müşteri tarafından belirlenen ürün kodu
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Ürünün tam adı
o Quantity (Double) : Miktarı
o Price (Double) : Fiyatı
o LineTotal (Doble) : Satır toplamı
o CurrencyName (String) : Para birimi
o Description (String) : Açıklama
o Vat (Double?) : Kdv
o DiscountType (Integer) : Satırın indirim tipi
0 – PercentOff : Yüzde indirim
1 – AmountOff : Miktar indirimi
o Discount (Double) : Satırın indirim miktarı
o Unit (String) : Birimi
ReadersIdToString (Array of String) : Okuma izinleri
WritersIdToString (Array of String) : Yazma izinleri
CanEdit (Boolean)
CanEditSharingRights (Boolean)
CustomerAddress
CustomerPhone
ChildProposals : Tekliflerin teklifleri
o Id
o Name : Adı
o LastName
o Brand : Markası
o ProdModel : Model
o Sku
o ClassName : Bulunduğu sınıf
o Type
o Own
o Displayname
o Email
o UiInfo
o TaxNo
o TaxOffice
ChildOrders : Tekliflerin siparişleri
o Id
o Name : Adı
o LastName
o Brand : Markası
o ProdModel : Model
o Sku
o ClassName : Bulunduğu sınıf
o Type
o Own
o Displayname
o Email
o UiInfo
o TaxNo
o TaxOffice
TemplateId (Integer?)
ValidUntilDate (DateTime?)
Description (String) : Açıklama
AdditionalInfo (String) : İlave bilgi
Stage (Integer) : Teklifin aşaması
o 0 – Choose (Seç)
o 1 – Pending (Bekliyor)
o 2 – Processing (Hazırlanıyor)
o 3 – Shipped (Sevk edildi)
SubmitDate (DateTime?)
StageChangeDate (DateTime?) : Değiştirilme zamanı
SubmittedBy
Attn : Firma
o Id (Integer)
o Name (String)
o LastName (String)
o ClassName (String)
o TaxNo (String)
o TaxOffice (String)
Id (Integer) : Teklif Id’si
Name (String) : Teklifin adı
Displayname (String) : Teklifin tam adı
CurrencyName (String) : Teklifin satış para birimi ismi
RelatedEntities (Array of Object) : Teklifin ilişkili olduğu diğer objeler
o Id (Integer)
o Name (String)
o LastName (String)
o Brand (String)
o ProdModel (String)
o Sku (String)
o ClassName (String)
o Type (String)
o Own (Boolean)
o Displayname (String)
o Email (String)
o UiInfo (String)
o TaxNo (String)
o TaxOffice (String)
RelatedEntity : Teklifin Müşterisi
o Id (Integer)
o Name (String)
o LastName (String)
o ClassName (String)
o TaxNo (String)
o TaxOffice (String)
Owner : Sahibinin
o Id (Integer)
o Name (String)
o LastName (String)
o ClassName (String)
o TaxNo (String)
o TaxOffice (String)
Tags (Array) : Etiketler
LastActivityDate (DateTime?) : Teklifin en son aktivite tarihi
EnteredDate (DateTime) : Teklifin oluşturulduğu tarih
ModifiedDate (DateTime?) : Teklifin en son değiştirildiği tarih
Discount (Double) : Teklifin indirim miktarı
DiscountType (Integer) : Teklifin indirim tipi
o 0 – PercentOff : Yüzde indirim
o 1 – AmountOff : Miktar indirimi
DiscountedTotal (Double) : Toplam indirim
ParentProposal : Eğer var ise Teklifin teklifi
o Id (Integer)
o Name (String)
o LastName (String)
o Brand (String)
o ProdModel (String)
o Sku (String)
o ClassName (String)
o Type (String)
o Own (Boolean)
o Displayname (String)
o Email (String)
o UiInfo (String)
o TaxNo (String)
o TaxOffice (String)
DiscountCurrencyName (String) : Eğer miktar indirimi ise indirimin para birimi
ModifiedBy : Değiştiren kişinin
o Id
o Name : Adı
o Controller
o Own
o ProfilePictureFileKey
EnteredBy : Teklifi oluşturan
o Id
o Name
o Controller
o Own
o ProfilePictureFileKey
NoTotal
VatType (Integer): Kdv kullanımı
o 0 – NoVat : Kdv yok
o 1 – VatExclusive : Kdv hariç
o 2 – VatInclusive : Kdv dahil
AddedToAccounting (bool) : Cari hespalara eklenmiş
MailSent (bool) : Bu sipariş için müşteriye mail gönderilmiş
CustomRates : Özel fiyatlar
o FromCurrencyName (String) : Hangi para biriminden
o ToCurrencyName (String): Hangi para birimine
o Rate (Double) : Oran
Düzenleme
Bu method, post edilen teklifin model id'si sistemde mevcut ise güncelleme, değil yani defult(0) ise
ekleme işlemi yapmaktadır. Metod post ile gelen modelin id'sine göre işleme tabi tutulmaktadır. id'yi
0 olarak verirseniz create olarak calisir. id>0 ise güncelleme yapar.
URL
POST https://api.teamgram.com/[ŞİRKETİSMİ]/Proposals/Edit
Request
Id (Integer) : Teklif Id’si
AttnId (Integer?)
stage (Integer) : Teklifin aşaması
o 0 – Draft
o 1 – Submitted
o 2 – RevisionRequested
o 3 – Rejected
o 4 – Accepted
o 5 – Abandoned
o 6 – Withdrawn
o 7 – Revised
o 8 - Waiting
CustomerAddress (String) : Müşterinin adresi
ParentProposalId (Integer) : Tekliflerin bağlantıları
Displayname (String) : Teklifin tam adı
ValidUntilDate (DateTime?)
ClearValidUntilDate (Boolean)
Tags (Array of String) : Etiketler
Name (String) : Teklifin adı
RelatedEntityId (Integer) : Teklifin müşteri Id’si
RelatodOpportunityId (Integer)
Items (Array of Object) : Teklifin detayları
o Product : Ürün
Id (Integer): Ürünün Id’si
o Quantity (Double) : Miktarı
o Price (Double) : Fiyatı
o CurrencyName (String) : Para birimi
o Description (String) : Açıklama
o Vat (Double?) : Kdv
o DiscountType (Integer) : Satırın indirim tipi
0 – PercentOff : Yüzde indirim
1 – AmountOff : Miktar indirimi
o Discount (Double) : Satırın indirim miktarı
o Unit (String) : Birimi
CustomFieldDatas (Array) : Özel alan veri listesi
o CustomFieldId (Integer) : Özel alan Id’si
o Value (String)
RelatedEntityIds (String)
Discount (Double?) : Teklifin indirim miktarı
DiscountType (Integer) : Teklifin indirim tipi
o 0 – PercentOff : Yüzde indirim
o 1 – AmountOff : Miktar indirimi
DiscountCurrencyName (String) : Eğer miktar indirimi ise indirimin para birimi
OwnerId (Integer) : Teklifin sahibinin Id’si
VatType (Integer): Kdv kullanımı
o 0 – NoVat: Kdv yok
o 1 – VatExclusive: Kdv hariç
o 2 – VatInclusive: Kdv dahil
CustomerPhone (String)
TemplateId (Integer?)
CustomRates : Özel fiyatlar
o FromCurrencyName (String) : Hangi para biriminden
o ToCurrencyName (String): Hangi para birimine
o Rate (Double) : Oran
Response
Result (Boolean)
Id (Integer) : Teklifin Id’si
Message (String) : Hata durumunda gelir, hata mesajıdır
MessageCode (Integer) : Hatanın detayları burada mevcuttur
o NULL: No error
o 0: GeneralError
o 1: EntityLimitExceeded
o 2: MaxStorageExceeded
o 3: MaxFileSizeExceeded
o 4: MonthlyMaxFilesExceeded
o 5: CreateRestriction
o 6: RequiredDataMissing
Güncelleme Durumu
Bu method teklifin düzenlenebilir olup olmadığını döner.
URL
POST https://api.teamgram.com/[ŞİRKETİSMİ]/Proposals/UpdateStatus
Request
id (Integer) : Teklifin Id’si
stage (Integer) : Teklifin aşaması
o 0 – Draft
o 1 – Submitted
o 2 – RevisionRequested
o 3 – Rejected
o 4 – Accepted
o 5 – Abandoned
o 6 – Withdrawn
o 7 – Revised
o 8 - Waiting
date (DateTime?)
Response
Result: (Boolean)
Id (Integer) : Teklifin Id’si
Color (String) : Teklifin rengi
SubmitDate (DateTime?)
StageChangeDate (DateTime?) : Değiştirilme tarihi
SubmittedBy : Oluşturan kişinin
o Id (Integer)
o Name (String) : Adı
o Controller
o Own
o ProfilePictureFileKey : Profil resmi
Silme
Bu method ile teklif silinir.
URL
POST https://api.teamgram.com/[ŞİRKETİSMİ]/Proposals/Delete
Request
Id (Integer) : Teklifin Id’si
Response
Result: (Boolean)
Durum logları
Bir teklifin, yapılan durum güncellemelerinin loglarını getirir.
URL
https://api.teamgram.com/[ŞİRKETİSMİ]/Proposals/StatusLog
Request
Id (int) Teklifin Id’si
Response
Indate (DateTime) : Güncellemenin yapıldığı tarih
Who (Integer) : Güncellemeyi yapan kişi
Status (Integer) : Teklifin durumu
o 0 – OpenNew (Açık)
o 1 – ClosedFulfilled (Tamamlandı)
o 2 – Cancelled (İptal)
Stage (Integer) : Teklifin aşaması
o 0 – Choose (Seç)
o 1 – Pending (Bekliyor)
o 2 – Processing (Hazırlanıyor)
o 3 – Shipped (Sevk edildi)
Özel Uygulamalar
Özel uygulamalar işinizi kolayca takip edebilmeniz adına hazır form ve veritabanlarını temsil eder.
Listeleme
Bu method özel uygulamaları listeler.
URL
GET https://api.teamgram.com/v1/[ŞİRKETİSMİ]/CustomApplications/GetCustomAppList
Response
CustomFields (Array of Object) : Özel alanlar
o Id (Integer)
o Name (String) : Özel alan başlığı
o EntityType (String) : “Party”
o Type (Integer)
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Required (Boolean)
o PropertiesPulldownStrings (String Array): Pulldown tipli alanların içeriği
o Order (Integer): Gösterilme sırası
ReadersIdToString (Array of String) : Okuma izinleri
WritersIdToString (Array of String) : Yazma izinleri
Id (Integer) : Özel alan Id’si
Name (String) : Özel alana verilen bireysel adı
Icon (String)
Approval (Boolean) : Onaylama
Görme
Bu method özel uygulamaların içinde bulunan, istenilen belgenin detaylarını getirir.
URL
GET https://api.teamgram.com/v1/[ŞİRKETİSMİ]/CustomApplications/GetDocumentOfApp
Request
Id (Integer) : Özel uygulama içindiki belge Id’si
Response
Id (Integer)
Name (String) : Özel alana verilen bireysel adı
Descrition (String) : Özel alan açıklaması
EnteredDate (DateTime) : Oluşturma zamanı
ModifiedDate (DateTime?) : Düzenleme zamanı
LastActivityDate(DateTime?) : İşin en son aktivite tarihi
ModifiedBy : Düzenleyen kişi
o Id (Integer)
o Name (String) : Adı
o Controller
o Own
o ProfilePictureFileKey : Profil resmi
EnteredBy : Oluşturan kişi
o Id (Integer)
o Name (String) : Adı
o Controller
o Own
o ProfilePictureFileKey : Profil resmi
Tags (Array of String) : Etiketler
ApproveBy
o Id (Integer)
o Name (String) : Adı
o Controller
o Own
o ProfilePictureFileKey : Profil resmi
Status (Integer) : Durum
o 0 – Draft
o 1 – WaitingForApproval
o 2 – Approved
o 3 – Rejected
ApproveDate (DateTime?) : Onaylanma tarihi
CanApprove (Boolean) : Onaylandı
CustomFieldDatas (Array) : Özel alan veri listesi
o Id (Integer)
o CustomFieldId (Integer)
o IsRequired (Boolean)
o RelatedEntity
Id (Integer)
Name (String) : Adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
TaxNo (String)
TaxOffice (String)
o ScanCode (Boolean)
o ListValues (Array of String)
o UnFormettedDate (String) : Formatsız tarih
o UnFormattedNumber (String) : Formatsız rakam
o CustomFieldName (String)
o CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Value (String)
o Values (String)
Application : Uygulama
o Id (Integer)
o Name (String)
o Icon (String)
o Approval (Boolean) : Onaylama
HasWriterPermission (Boolean)
ReadersIdToString (Array of String) : Okuma izinleri
WritersIdToString (Array of String) : Yazma izinleri
CanEdit (Boolean)
CanEditSharingRights (Boolean)
Owner
o Id (Integer)
o Name (String)
o Controller (String)
o Own (Boolean)
o ProfilePictureFileKey (String)
StatusColor (String)
Çoklu Görme
Bu method özel uygulamaların içinde bulunan, istenilen kadar belgenin detaylarını getirir.
URL
https://api.teamgram.com/v1/[ŞİRKETİSMİ]/CustomApplications/GetDocumentsOfApp
Request
filter
o own (Array of Integer)
o kwd (String)
o listValueFilter (Array of String)
o dateFilter (Array of Object)
Id (Integer)
MinValue (String)
MaxValue (String)
o sbf (String) : orderByParam: birincil sıralama
o sbt (String) : orderByDir: artan sıralama için "a", azalan sıralama için "d"
o tbf (String) : thenOrderByParam: ikincil sıralama
o tbt (String) : thenOrderByDir: artan sıralama için "a", azalan sıralama için "d"
o cd1 (String) : createDateMin
o cd2 (String) : createDateMax
o md1 (String) : modifyDateMin
o md2 (String) : modifyDateMax
o cdt (String) : modifyDateMin
o mdt (String) : modifyDateMax
o sts (Array of Integer) : status
o app (Array of Integer) : approved by
o tids (String)
o tagOp (String)
appid (Integer)
page (Integer?)
pageSize (Integer: default:20)
entityid (Integer: default:0)
fid (Integer?: default:null)
Response
Application : Uygulama
o Id (Integer)
o Name (String)
o Icon (String)
o Approval (Boolean) : Onaylama
Forms
o Id (Integer)
o Name (String)
o EnteredDate (DateTime) : Oluşturma tarihi
o CustomFieldDatas (Array of Object) : Özel alanlar
CustomFieldName (String) : Özel alan adı
CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
Value (String)
Values (String)
o CustomApplicationIconName (String) : Özel uygulamanın icon adı
o CustomApplicationId (Integer) : Özel uygulamanın Id’si
o CustomApplicationName (String) : Özel uygulamanın adı
o Status (Integer) : Durum
0 – Draft
1 – WaitingForApproval
2 – Approved
3 – Rejected
o Approval (Boolean) : Onaylama
o ApprovedByName (String) : Onaylayanın adı
o ApproveDate (DateTime?) : Onaylama tarihi
o StatusColor (String) : Durum rengi
o MailSent (Boolean) : Mail gönderildi
OwnerList (Array of Object) : Uygulama yetkisi olanların listesi
o Id (Integer)
o Name (String) : Adı
o LastName (String)
o ClassName (String) : Cinsi (Party, Individual etc.)
o TaxNo (String)
o TaxOffice (String)
SortItems (Dictionary<String,String>)
HasListFields (Boolean) : Özel alan listesi var
HasDateFields (Boolean)
ListItems (Array of Object)
o Id (Integer)
o Name (String)
o PulldownStrings (Array of String) : Pulldown tipli alanların içeriği
DateFields (Array of Object)
o CustomFieldId (Integer) : Özel alan Id’si
o CustomFieldName (String) : Özel alan adı
o CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
Filters (Array of Object)
o Name (String)
o Id (Integer)
Dökümanları görme
Bu method istenilen varlığın (sipariş, ürün, kişi, firma) dökümanlarını getirir.
URL
https://api.teamgram.com/v1/[ŞİRKETİSMİ]/CustomApplications/GetDocumentsOfEntity
Request
Entityid (Integer) : Varlığın Id’si (sipariş, ürün, kişi, firma...)
Page (Integer?)
pageSize (Integer: default:20)
Response
Forms
o Id (Integer)
o Name (String)
o EnteredDate (DateTime) : Oluşturma tarihi
o CustomFieldDatas (Array of Object) : Özel alanlar
CustomFieldName (String) : Özel alan adı
CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
Value (String)
Values (String)
o CustomApplicationIconName (String) : Özel uygulamanın icon adı
o CustomApplicationId (Integer) : Özel uygulamanın Id’si
o CustomApplicationName (String) : Özel uygulamanın adı
o Status (Integer) : Durum
0 – Draft
1 – WaitingForApproval
2 – Approved
3 – Rejected
o Approval (Boolean) : Onaylama
o ApprovedByName (String) : Onaylayanın adı
o ApproveDate (DateTime?) : Onaylama tarihi
o StatusColor (String) : Durum rengi
o MailSent (Boolean) : Mail gönderildi
OwnerList (Array of Object)
o Id (Integer)
o Name (String) : Adı
o LastName (String)
o ClassName (String) : Cinsi (Party, Individual etc.)
o TaxNo (String)
o TaxOffice (String)
SortItems (Dictionary<String,String>)
HasListFields (Boolean) : Özel alan listesi var
HasDateFields (Boolean)
ListItems (Array of Object)
o Id (Integer)
o Name (String)
o PulldownStrings (Array of String) : Pulldown tipli alanların içeriği
DateFields (Array of Object)
o CustomFieldId (Integer) : Özel alan Id’si
o CustomFieldName (String) : Özel alan adı
o CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
Filters (Array of Object)
o Name (String)
o Id (Integer)
Görevler
İş listelerini temsil eder.
Listeleme
Bu method işleri listeler.
URL
https://api.teamgram.com/[ŞİRKETİSMİ]/Tasks/Index
Request
page (Integer: default:1)
pagesize (Integer: default:20)
ofid (Integer: default:0)
own (Boolean: default:false)
fid (Integer?: default:null)
Response
Filters
o Name (String)
o Id (Integer)
Tasks (Array of Object) : İşler
o Id (Integer) : İşin Id’si
o Name (String) : İşin adı
o Completed (Boolean) : İş tamamlandı
o AssignedTo (Array of Object) : Kime atandı
Id (Integer) : Atananın Id’si
Name : Adı
Controller
Own
ProfilePictureFileKey
o DueDate (DateTime?) : Tamamlanması beklenen süre
o StartDate (DateTime?) : Başlama tarihi
o CompletionDate (DateTime?) : Tamamlanma tarihi
o CanComplete (Boolean)
o Priority (Integer) : Önceliği
o Progress (Integer?) : İlerleyişi
o Repeat (Integer) : Tekrar etmesi
o RemindersCount (Integer) : Hatırlatma adeti
CurrentIndividualId (Integer) :
CurrentIndividualName (String)
CustomFields (Array of Object) : Özel alanlar
o Id (Integer)
o Name (String) : Özel alan başlığı
o EntityType (String) : “Party”
o Type (Integer)
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Required (Boolean)
o PropertiesPulldownStrings (String Array): Pulldown tipli alanların içeriği
o Order (Integer): Gösterilme sırası
Görme
Bu method verilen Id’ye göre döner.
URL
https://api.teamgram.com/[ŞİRKETİSMİ]/Tasks/Get
Request
id (Integer)
Response
RelatedEntities
o Id (Integer)
o Name (String) : Adı
o Controller
o Own
o ProfilePictureFileKey : Profil resmi
Owner : İşin sahibi
o Id (Integer)
o Name (String) : Adı
o Controller
o Own
o ProfilePictureFileKey : Profil resmi
Description (String) : Açıklama
Tags (Array of String) : Etiketler
CanEdit (Boolean) : Değiştirilmiş
CanEditSharingRights (Boolean)
CustomFieldDatas (Array) : Özel alan veri listesi
o Id (Integer)
o CustomFieldId (Integer) : Özel alan Id’si
o IsRequired (Boolean)
o RelatedEntity
Id (Integer)
Name (String) : Adı
LastName (String)
ClassName (String) : Cinsi (Party, Individual etc.)
Displayname (String) : Tam adı
TaxNo (String)
TaxOffice (String)
o ScanCode (Boolean)
o ListValues (Array of String)
o UnFormettedDate (String) : Formatsız tarih
o UnFormattedNumber (String) : Formatsız rakam
o CustomFieldName (String) : Özel alan adı
o CustomFieldType (Integer) : Özel alan tipi
0 – String
1 – MultiLine
2 – Number
3 – Date
4 – DateTime
5 – PullDown
6 – Attachment
7 – Company
8 – Contact
9 – User
10 – Product
11 – Opportunity
12 – ContactCompany
13 – Digit
14 – Phone
15 – Order
16 – Proposal
17 – GeoLocation
o Value (String)
o Values (String)
ReadersIdToString (Array of String) : Okuma izinleri
WritersIdToString (Array of String) : Yazma izinleri
Reminders (Array of Object) : Hatırlatmalar
o Id (Integer) : Hatırlatma Id’si
o At (DateTime)
o Text (String) : Hatırlatma
o SendDate (DateTime?) : Hatırlatma zamanı
o Status (Integer) : İşin durumu
0 – New
1 – Selected
2 – Sent
o TimeZone (String)
LastActivityDate (DateTime?) : İşin en son aktivite tarihi
EnteredDate (DateTime) : İşin oluşturulduğu tarih
ModifiedDate (DateTime?) : İşin en son değiştirildiği tarih
ModifiedBy : Değiştiren kişi
o Id
o Name
EnteredBy : Giren kişi
o Id
o Name
Id (Integer)
Name (String)
Completed (Boolean)
AssignedTo (Array of Object) : Kime atandı
o Id (Integer) : Atananın Id’si
o Name : Adı
o Controller
o Own
o ProfilePictureFileKey
DueDate (DateTime?) : Tamamlanması beklenen süre
StartDate (DateTime?) : Başlama tarihi
CompletionDate (DateTime?) : Tamamlanma tarihi
CanComplete (Boolean)
Priority (Integer) : Önceliği
Progress (Integer?) : İlerleyişi
Repeat (Integer) : Tekrar etmesi
RemindersCount (Integer) : Hatırlatma adeti
Görme
Bu method istenilen işi listeler.
URL
POST https://api.teamgram.com/v1/[ŞİRKETİSMİ]/Tasks/WhatsNext
Request
whatsnextOppId (Integer) : Sonraki İşin Id’si
whatsnextName (String) : Sonraki işin adı
whatsnextDue (DateTime?) : Sonraki işin süresi
Response
Result (Boolean)
Id (Integer)
OppId (Integer)
Silme
Bu method silme işlemi yapar.
URL
https://api.teamgram.com/[ŞİRKETİSMİ]/Tasks/Delete
Request
id (Integer)
Response
result (Boolean)
Tamamlama
Bu method işi tamamlandı veya tamamlanmadı yapar.
URL
https://api.teamgram.com/[ŞİRKETİSMİ]/Tasks/Complete
Request
id (Integer)
Response
result (Boolean)
Süreci güncelleme
Bu method işin şuan ki durumunu değiştirir.
URL
https://api.teamgram.com/[ŞİRKETİSMİ]/Tasks/UpdateProgress
Request
id (Integer)
progress (Integer) : İlerleyiş
Response
result (Boolean)
Hatırlatma ekleme
Bu method işe bir hatırlatma bilgisi eklenir.
URL
POST https://api.teamgram.com/[ŞİRKETİSMİ]/Tasks/ReminderAdd
Request
id (Integer)
info (String)
Response
Id (Integer) : Hatırlatma Id’si
result (Boolean)
Hatırlatma silme
Bu method istenilen hatırlatmayı siler.
URL
https://api.teamgram.com/[ŞİRKETİSMİ]/Tasks/ReminderDelete
Request
id (Integer) : İşin Id’si
remId (Integer) : Hatırlatma Id’si
Response
result (Boolean)
Oluşturma
Bu method işlerin listesini getirir.
URL
POST https://api.teamgram.com/[ŞİRKETİSMİ]/Tasks/Create
Request
AssignedToIds (Array of Integer) : Atanan kişi
RelatedEntityIds (Array of Integer)
ReadersIdToString (Array of String) : Okuma izinleri
WritersIdToString (Array of String) : Yazma izinleri
CanEditSharingRights (Boolean)
OwnerId (Integer)
CustomFieldDatas (Array) : Özel alan veri listesi
o CustomFieldId (Integer) : Özel alan Id’si
o Value (String)
Subject (String) : Konu
Description (String) : Açıklama
DueDate (DateTime?) : Tamamlanması beklenen süre
CompletionDate (DateTime?) : Tamamlanma tarihi
Completed (Boolean) : Tamamlandı
Priority (Integer) : Önceliği
StartDate (DateTime?) : Başlama tarihi
Progress (Integer?) : İlerleyiş
Tags (Array of String) : Etiketler
Repeat (Integer?) : Tekrar etmesi
Reminders (Array of String) : Hatırlatmalar
Response
Result (Boolean)
Id (Integer): oluşan şirketin unique Id’si
Message (String)
MessageCode (Integer)
o NULL: No error
o 0: GeneralError
o 1: EntityLimitExceeded
o 2: MaxStorageExceeded
o 3: MaxFileSizeExceeded
o 4: MonthlyMaxFilesExceeded
o 5: CreateRestriction
o 6: RequiredDataMissing
Çoklu görme
Bu method işlerin listesini getirir.
URL
https://api.teamgram.com/v1/[ŞİRKETİSMİ]/Tasks/WhatsNextList
Request
entityType (String)
Response
result (Boolean)
items (Array of Object)
o RelatedEntities
Id (Integer)
Name (String) : Adı
Controller
Own
ProfilePictureFileKey : Profil resmi
o Id (Integer) : İşin Id’si
o DueDate (DateTime?) : Süresi
o Name (String)
o Completed (Boolean)
o CompletionDate (DateTime?)
o ListDate (String)
o OwnerId (Integer) : İşin sahibi
Sonraki liste
Bu method bir işin sonraki listesini verir.
URL
https://api.teamgram.com/v1/[ŞİRKETİSMİ]/Tasks/WhatsNextListOfAnEntity
Request
id (Integer)
Response
result (Boolean)
items (Array of Object)
o Id (Integer) : İşin Id’si
o DueDate (DateTime?) : Süresi
o Name (String)
o Completed (Boolean)
o CompletionDate (DateTime?)
o ListDate (String)
o OwnerId (Integer) : İşin sahibi
Düzenleme
Bu method iş düzenlemek için kullanılmaktadır.
URL
POST https://api.teamgram.com/v1/[ŞİRKETİSMİ]/Tasks/Edit
Request
Id (Integer)
AssignedToIds (Array of Integer) : Atanan kişi
RelatedEntityIds (Array of Integer)
ReadersIdToString (Array of String) : Okuma izinleri
WritersIdToString (Array of String) : Yazma izinleri
CanEditSharingRights (Boolean)
OwnerId (Integer)
CustomFieldDatas (Array) : Özel alan veri listesi
o CustomFieldId (Integer) : Özel alan Id’si
o Value (String)
Reminders (Array of String) : Hatırlatmalar
Response
Result (Boolean)
Id (Integer)