Vereceğiniz sorgu modeli(InboxInvoiceQueryModel) ile faturaları içeren InvoiceData tipinde bir byte dizisi olarak döndürülmesini sağlar.
Test servisinde Username/Password geneldir. Canlıda bu bilgileri müşteri bazlı kullanılacaktır. Üyelik alım sonrasında verilen bilgilerle login sağlanır. Username/Password bilgisi body içinde userInfo altında giriş sağlanmaktadır.
Test hepsiburadaefaturam Portaline buradan erişebilirsiniz.
Username: HBTest1
Password: HBTest1
{
"Action": "GetInboxInvoicesData",
"parameters": {
"userInfo": {
"Username": "HBTest1",
"Password": "HBTest1"
},
"query": {
"ExecutionStartDate": "2023-01-10T23:59:59.999",
"ExecutionEndDate": "2023-05-04T23:59:59.999",
"PageSize": 1,
"PageIndex": 1
}
}
}
Parametreler
InboxInvoiceQueryModel nesnesi çeşitli fatura getirme sorguları için esneklik sağlamak amacıyla oluşturulmuş bir nesnedir. Property’leri aşağıda listelenmiştir.
1 – PageSize(int) : Kaç adet faturanın tek seferde döneceğini belirtmeye yarayan property’dir.
2 – PageIndex(int) : Metodu çağırdığınızda hangi sayfadaki faturaların getirilmesi gerektiği ile ilgili değerin girileceği property’dir.
3 – InvoceIds(List) : List şeklinde fatura UUID alanlarının string dizisi şeklinde gönderilerek ilgili faturaların getirilebileceği property.
4 – OnlyNewestInvoices(true\false) : Sadece yeni gelmiş(yeni işareti kaldırılmamış) faturaları getirmek için kullanılabilecek property.
5 – SetTaken(true\false) : Daha önce yeni işareti kaldırılmamış ise Query Model sonucunda gelecek faturaların yeni işaretini kaldırmaya yarar.
6 – ExecutionStartDate(DateTime) : Faturanın oluşturulma tarihine göre bu tarihten sonra oluşturulmuş faturaların getirilmesine yarar.
7 – ExecutionEndDate(DateTime) : Faturanın oluşturulma tarihine göre bu tarihten önce oluşturulmuş faturaların döndürülmesimi sağlar.
Return Değeri
Return tipi Response olan metoda vermiş olduğunuz parametrelere göre gelen faturalar Response.Value değerindeki Items değeri içerisindeki Value.Data alanında dönmektedir. Ayrıca Value içerisindeki TotalCount Gelen Toplam fatura sayısını; TotalPage ise toplam kaç sayfa fatura olduğunu döndürür.