Vereceğiniz sorgu modeli(InvoiceQueryModel) ile gönderilmiş olan faturaların InvoiceData tipinde byte dizisi olarak döndürür.
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": "GetOutboxInvoicesData",
"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
InvoiceQueryModel 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 gönderilerek ilgili faturaların getirilebileceği property.
4 – ExecutionStartDate(DateTime) : Faturanın oluşturulma tarihine göre bu tarihten sonra oluşturulmuş faturaların getirilmesine yarar.
5– 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 metod’a vermiş olduğunuz parametrelere göre gelen faturalar Response.Value değerindeki Items değeri içerisinde bir InvoiceData nesnesi döndürmektedir. Items.Invoice UBL-TR formatındaki Xml fatura nesnesinin byte dizisi halidir. Bu Xml yasal olarak geçerliliği olan imzalı dokümandır. Ayrıca Response.Value içerisindeki TotalCount Gelen Toplam fatura sayısını; TotalPage ise toplam kaç sayfa fatura olduğunu döndürür.