DBS Fatura Sorgula

Bu API sisteminde yer alan fatura bilgilerini getirmektedir.

Fatura No İle Fatura Sorgula
Sistemde yer alan fatura bilgilerine fatura numarasına göre ulaşmak için kullanılmaktadır. MainCompanyID, MainCompanyDealerCode, InvoiceNumber, QueryType zorunlu alanlardır. ParentCompanyID opsiyonel alandır.

Vade Tarihine Göre Fatura Sorgula
Sistemde yer alan fatura bilgilerine belirli bir vade tarihi aralığına göre ulaşmak için kullanılmaktadır. MainCompanyID, StartDate, EndDate, QueryType zorunlu alanlardır. MainCompanyDealerCode, CurrencyCode ve ParentCompanyID opsiyonel alanlardır.

Tahsilat Tarihine Göre Fatura Sorgula
Sistemde yer alan fatura bilgilerine tahsilat tarihi aralığına göre ulaşmak için kullanılmaktadır. MainCompanyID, StartDate, EndDate, QueryType zorunlu alanlardır. MainCompanyDealerCode, CurrencyCode ve ParentCompanyID opsiyonel alanlardır.

Sisteme Giriş Tarihine Göre Fatura Sorgula
Sistemde yer alan fatura bilgilerine sisteme giriş tarihi aralığına göre ulaşmak için kullanılmaktadır. MainCompanyID, StartDate, EndDate, QueryType zorunlu alanlardır. MainCompanyDealerCode, CurrencyCode ve ParentCompanyID opsiyonel alanlardır.

API Bilgileri

URL

 /inquireDDSInvoice

Metot

 POST

Versiyon

 1.0

Scope

 payment

Yetkilendirme Yöntemi

 B2B Credentials


Girdi Bilgileri

Alan Adı Format Açıklama Zorunlu/Opsiyonel

QueryType

 Integer (1) Sorgu türü
1: Tahsilat Tarihine Göre Fatura Sorgulama,
2: Vade Tarihine Göre Fatura Sorgulama,
3: Sisteme Giriş Tarihine Göre Fatura Sorgulama,
4: Fatura No İle Fatura Sorgulama		 Zorunlu

MainCompanyID

 Integer (19) Bankanın ana firmaya verdiği tekil numara Zorunlu

MainCompanyDealerCode

 String (30) Ana firmanın bayiye verdiği bayi kodu Koşullu Zorunlu

InvoiceNumber

 String (20) Ana firmanın faturaya verdiği numara Koşullu Zorunlu

StartDate

 yyyy-MM-ddTHH24:mm:ss Başlangıç tarihi Koşullu Zorunlu

EndDate

 yyyy-MM-ddTHH24:mm:ss Bitiş tarihi Koşullu Zorunlu

ParentCompanyID

 Integer (19) Bankanın üst kuruma verdiği kod Opsiyonel

CurrencyCode

 String (3) Faturanın döviz cinsi
DBS/BTS Servisleri sekmesinde açıklanmıştır		 Opsiyonel


Çıktı Bilgileri

List< InvoiceInfo >

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

InvoiceNumber

 Integer Ana firmanın faturaya verdiği numara

InvoiceAmount

 Decimal Fatura tutarı

CurrencyCode

 String Döviz kodu

NameSurname

 String Ana firma tarafından gönderilen bayi adı/ünvanı

LastPaymentDate

 yyyy-MM-ddTHH24:mm:ss Fatura son ödeme tarihi

InvoiceType

 Integer Faturanın türü
1: Vadeli fatura, 2: Peşin fatura

Description

 String Açıklama

InvoiceReleaseDate

 yyyy-MM-ddTHH24:mm:ss Firmaların faturalarını kendi sistemlerinde oluşturdukları tarih

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

InvoiceStatus

 Integer Fatura Durum 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

CollectionCurrencyCode

 String Tahsilat işleminin gerçekleştiği döviz cinsi

CollectionExchangeRate

 Decimal Tahsilat işleminin gerçekleştirildiği dövizin kur bilgisi

CollectionDate

 yyyy-MM-ddTHH24:mm:ss Tahsilatın gerçekleştiği tarih bilgisi

DeductedAmount

 Decimal Faturadan düşen tutar bilgisi


Mesaj Kodları

Mesaj Kodu Açıklama

ACBH000025

 Başlangıç tarihi formatı hatalıdır.

ACBH000026

 Bitiş tarihi formatı hatalıdır.

ACBH000028

 Döviz kodu alanına geçersiz bir değer girildi.

ACBH000100

 Başlangıç tarihi bitiş tarihinden büyük olamaz.

ACBH000161

 Sorgu türü alanı 1 ile 4 arasında olmalıdır.

ACBH000162

 Ana firma id uygun formatta girilmelidir.

ACBH000163

 Bayi kodu uygun formatta girilmelidir.

ACBH000164

 Fatura numarası uygun formatta girilmelidir.

ACBH000165

 Bayi kodu / Fatura numarası boş bırakılamaz. Sorgu türü: {0}

ACBH000166

 Başlangıç tarihi / Bitiş tarihi boş bırakılamaz. Sorgu türü: {0}

ACBH000174

 İlgili işlem bireysel müşteri numarası ile yapılamaz.

Örnek

İstek:

Fatura No İle Fatura Sorgula
{
    "QueryType": 4,
    "MainCompanyID": 371004,
    "MainCompanyDealerCode": "apitest1",
    "InvoiceNumber": "1089"
} 

Sisteme Giriş Tarihine Göre Fatura Sorgula
{
    "QueryType": 3,
    "MainCompanyID": 371004,
    "MainCompanyDealerCode": "apitest1",
    "StartDate": "2020-01-12T00:00:00+03:00",    
    "EndDate": "2020-11-28T00:00:00+03:00",
    "CurrencyCode": "TL"
}

Cevap:

{
    "Header": {
        "StatusCode": "APIGW000000",
        "StatusDescription": "Completed",
        "ObjectID": "48cfbfb0-1cdc-4425-bc57-6ab8aa5c76e6"
    },
    "Data": {
        "InvoiceInfo": [
            {
                "InvoiceStatusCode": 2,
                "LastPaymentDate": "2021-01-01T00:00:00",
                "InvoiceAmount": 60,
                "MainCompanyID": 371004,
                "InvoiceType": 1,
                "TransactionId": 2020000032898432,
                "CurrencyCode": "TL",
                "InvoiceStatusDetailCode": 10,
                "InvoiceNumber": 1089,
                "SystemEntryDate": "2020-12-16T10:30:27",
                "InvoiceStatus": 7,
                "MainCompanyDealerCode": "apitest1",
                "RemainingAmount": 60
            }
        ]
    }
}