Implementation Notes
Bu API bir bayinin yeni bir fatura kaydetme işlemini gerçekleştirmektedir.
URL |
/uploadDDSInvoice |
Metot |
POST |
Versiyon |
1.0 |
Scope |
payment |
Yetkilendirme Yöntemi |
Authorization Code |
Alan Adı | Format | Açıklama | Zorunlu/Opsiyonel |
MainCompanyID |
Integer (19) | Bankanın ana firmaya verdiği tekil numara | Zorunlu |
MainCompanyDealerCode |
String (30) | Ana firmanın bayiye verdiği bayi kodu | Zorunlu |
InvoiceNumber |
String (20) | Ana firmanın faturaya verdiği numara | Zorunlu |
InvoiceAmount |
Decimal (9,2) | Fatura tutarı | Zorunlu |
CurrencyCode |
String (3) |
Faturanın döviz cinsi DBS/BTS Servisleri sekmesinde açıklanmıştır |
Zorunlu |
AreaCode |
String | Firma tarafından bayileri bölgeye göre farklılaşması durumunda bayinin bölge kodu/adı bu alanda gönderilebilir. | Opsiyonel |
NameSurname |
String (80) | Ana firma tarafından gönderilen bayi adı/ünvanı | Opsiyonel |
LastPaymentDate |
yyyy-MM-ddTHH24:mm:ss | Fatura son ödeme tarihi | Zorunlu |
InvoiceType |
Integer (1) |
Faturanın türü 1: Vadeli fatura, 2: Peşin fatura |
Zorunlu |
Description |
String (200) | Açıklama | Opsiyonel |
InvoiceReleaseDate |
yyyy-MM-ddTHH24:mm:ss | Faturanın kurumdan çıktığı tarih, saat ve dakika | Opsiyonel |
Reference6 |
String (100) | Firmalar için ayrılan özel alan | Opsiyonel |
Reference7 |
String (100) | Firmalar için ayrılan özel alan | Opsiyonel |
Reference8 |
String (100) | Firmalar için ayrılan özel alan | Opsiyonel |
Reference9 |
String (100) | Firmalar için ayrılan özel alan | Opsiyonel |
Reference10 |
String (100) | Firmalar için ayrılan özel alan | Opsiyonel |
Alan Adı | Format | Açıklama |
MainCompanyID |
Integer | Bankanın ana firmaya verdiği tekil numara |
MainCompanyDealerCode |
String | Ana firmanın bayiye verdiği bayi kodu |
AreaCode |
String | Firma tarafından bayileri bölgeye göre farklılaşması durumunda bayinin bölge kodu/adı bu alanda gönderilebilir. |
InvoiceNumber |
Integer | Ana firmanın faturaya verdiği numara |
LastPaymentDate |
yyyy-MM-ddTHH24:mm:ss | Fatura son ödeme tarihi |
InvoiceAmount |
Decimal | Fatura tutarı |
CurrencyCode |
String | Faturanın döviz cinsi |
InvoiceReleaseDate |
yyyy-MM-ddTHH24:mm:ss | Firmaların faturalarını kendi sistemlerinde oluşturdukları tarih |
InvoiceStatus |
Integer |
Fatura Durum Kodları DBS/BTS Servisleri sekmesinde açıklanmıştır |
NameSurname |
String | Ana firma tarafından gönderilen bayi adı/ünvanı |
InvoiceType |
Integer |
Faturanın türü 1: Vadeli fatura, 2: Peşin fatura |
Description |
String | Açıklama |
CompanyName |
String | Ana Firma Adı |
GuaranteedAmountOriginal |
Decimal | Faturanın sisteme giriş anındaki garantili kısmı |
NonGuaranteedAmountOriginal |
Decimal | Faturanın sisteme giriş anındaki garantisiz kısmı |
AmountPaid |
Decimal | Faturanın ödenen kısmı |
OffsetAmount |
Decimal | Faturadan mahsup edilmiş tutarların toplamı |
TransactionId |
Integer | Sistem tarafından üretilen tekil işlem numarası |
InvoiceStatusCode |
Integer |
Faturanın durumu 1: Aktif, 2: Pasif |
InvoiceStatusDetailCode |
Integer |
DBS Durum Detay Kodları DBS/BTS Servisleri sekmesinde açıklanmıştır |
SystemEntryDate |
yyyy-MM-ddTHH24:mm:ss | Faturanın sisteme giriş tarihi |
RemainingAmount |
Decimal | Faturadan kalan tutar |
GuaranteedAmount |
Decimal | Faturadan kalan garantili tutar |
NonGuaranteedAmount |
Decimal | Faturadan kalan garantisiz tutar |
Reference6 |
String | Firmalar için ayrılan özel alan |
Reference7 |
String | Firmalar için ayrılan özel alan |
Reference8 |
String | Firmalar için ayrılan özel alan |
Reference9 |
String | Firmalar için ayrılan özel alan |
Reference10 |
String | Firmalar için ayrılan özel alan |
Mesaj Kodu | Açıklama |
ACBH000027 |
Döviz kodu boş olamaz. |
ACBH000028 |
Döviz kodu alanına geçersiz bir değer girildi. |
ACBH000162 |
Ana firma id uygun formatta girilmelidir. |
ACBH000163 |
Bayi kodu uygun formatta girilmelidir. |
ACBH000164 |
Fatura numarası uygun formatta girilmelidir. |
ACBH000167 |
Son ödeme tarihi formatı hatalıdır. |
ACBH000168 |
Fatura çıkış tarihi formatı hatalıdır. |
ACBH000169 |
Fatura türü alanına geçersiz değer girildi. |
ACBH000170 |
Bayi kodu boş bırakılamaz. |
ACBH000171 |
Fatura numarası boş bırakılamaz. |
ACBH000174 |
İlgili işlem bireysel müşteri numarası ile yapılamaz. |
ACBH000243 |
Son ödeme tarihi boş olamaz. |
İstek:
{ "MainCompanyID": 371004, "MainCompanyDealerCode": "apitest1", "InvoiceNumber": "1011012", "InvoiceAmount": 100, "CurrencyCode": "TL", "LastPaymentDate": "2021-03-01T00:00:00+03:00", "InvoiceType": 1, "AreaCode": "", "NameSurname": "", "Description": "", "InvoiceReleaseDate": "", "Reference6": "", "Reference7": "", "Reference8": "", "Reference9": "", "Reference10": "" }
Cevap:
{ "Header": { "StatusCode": "APIGW000000", "StatusDescription": "Completed", "ObjectID": "436874cd-3d26-4bcb-aadb-c01e3a4c610e" }, "Data": { "InvoiceInfo": { "CurrencyCode": "TL", "InvoiceStatusCode": 2, "LastPaymentDate": "2021-03-01T00:00:00+03:00", "InvoiceStatusDetailCode": 21, "InvoiceNumber": 1011012, "InvoiceAmount": 100, "MainCompanyID": 371004, "MainCompanyDealerCode": "apitest1", "InvoiceType": 1 } } }
API URL : https://apigw.vakifbank.com.tr:8443