QueryDocumentResponseStatus

InvoiceIds parametresi ile verilmiş olan bir yada daha fazla fatura yanıtının durumunu müşteriye bildirir. Müşteriler gönderdikleri fatura yanıtlarının son durumunu bu metodu kullanarak sorgulamalıdırlar. Faturanın Hepsiburada e-Faturam sistemi yada GIB sistemindeki durumu hakkında bilgi sahibi olunur.

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": "QueryDocumentResponseStatus",
  "parameters": {
    "invoiceIds": [
      "005056AA-EBE9-1EDD-ABD3-CEF2F3145B35"
    ],
    "userInfo": {
      "Username": "HBTest1",
      "Password": "HBTest1"
    }
  }
}

Parametreler
invoiceIds: Bir yada daha fazla fatura Id’si bu parametre ile geçilir. Fatura Id’si faturanın E-Fatura sistemindeki tekil idsidir. UBL-TR formatındaki UUID alanına denk gelir.

Return Değeri
Return tipi Response<List> olan metod’un Response’unun Value alanı bir ya da daha fazla DocumentResponseStatus içeren bir liste/array olacaktır.
Tüm sorgulanan fatura yanıtlarını her birisi için bir adet DocumentResponseStatus nesnesi Response.Value alanı içerisinde olacaktır.
DocumentResponseStatus: Bir fatura yanıtının durumu hakkında bilgi içermektedir.

  • InvoiceId: Durum bilgisi olan Fatura yanıtının Id’sini belirtir. Id değeri E-Fatura sistemindeki bu faturanın tekıl idsi olan ve UBL-TR de UUID olarak belirlenen alandır.
  • Message: Fatura yanıtının durumuna ait varsa özel bir durum mesajı bu alanda dönecektir.
  • Status: Fatura Yanıtının durum bilgisi aşağıdakilerden biri olarak dönecektir.
Enum DeğeriAçıklama
WaitingBeklemede
KuyruktaQueued
Processingİşleniyor
SentToGibGİB’e Gönderildi
SuccessBaşarılı
ErrorHata
Language
Click Try It! to start a request and see the response here!