GetOutboxInvoices

Vereceğiniz sorgu modeli(InvoiceQueryModel) ile gönderilmiş olan faturaların InvoiceInfo şeklinde 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": "GetOutboxInvoices",
  "parameters": {
    "userInfo": {
      "Username": "HBTest1",
      "Password": "HBTest1"
    },
    "query": {
      "ExecutionStartDate": "2023-01-10T23:59:59.999",
      "ExecutionEndDate": "2023-05-04T23:59:59.999",

      "StatusNotInList": [
        "10"
      ],
      "PageSize": "10",
      "PageIndex": "0"
    }
  }
}

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.

  • PageSize(int) : Kaç adet faturanın tek seferde döneceğini belirtmeye yarayan property’dir.
  • PageIndex(int) : Metodu çağırdığınızda hangi sayfadaki faturaların getirilmesi gerektiği ile ilgili değerin girileceği property’dir.
  • InvoceIds(List) : List şeklinde fatura UUID alanlarının gönderilerek ilgili faturaların getirilebileceği property.
  • ExecutionStartDate(DateTime) : Faturanın oluşturulma tarihine göre bu tarihten sonra oluşturulmuş faturaların getirilmesine yarar.
  • 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 InvoiceInfo nesnesi döndürmektedir. Items.Invoice UBL-TR formatındaki fatura nesnesidir. 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.

Language
Click Try It! to start a request and see the response here!