Vereceğiniz sorgu modeli(InboxInvoiceListQueryModel) ile gelen faturaların bazı temel bilgilerini içeren bir liste 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": "GetInboxInvoiceList",
"parameters": {
"userInfo": {
"Username": "HBTest1",
"Password": "HBTest1"
},
"query": {
"CreateStartDate": "2023-01-10T23:59:59.999",
"CreateEndDate": "2023-05-04T23:59:59.999",
"StatusNotInList": [
"10"
]
}
}
}
Parametreler
InboxInvoiceListQueryModel nesnesi çeşitli fatura listesi 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 – ExecutionStartDate(DateTime) : Faturanın tarihine göre bu tarihten sonra oluşturulmuş faturaların getirilmesine yarar.
6 – ExecutionEndDate(DateTime) : Faturanın tarihine göre bu tarihten önce oluşturulmuş faturaların döndürülmesimi sağlar.
7 – CreateStartDate(DateTime) : Faturanın oluşturulma tarihine göre bu tarihten sonra oluşturulmuş faturaların getirilmesine yarar.
8 – CreateEndDate(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< InboxInvoiceListResponse > olan metod’a vermiş olduğunuz parametrelere göre gelen fatura bilgileri Response.Value değerindeki Items değeri içerisindeki InboxInvoiceListItem alanında dönmektedir. Ayrıca Value içerisindeki TotalCount Gelen Toplam fatura sayısını; TotalPage ise toplam kaç sayfa fatura bilgisi olduğunu döndürür.