InvoiceIds parametresi ile verilmiş olan bir yada daha fazla faturanın durumunu müşteriye bildirir. Müşteriler gönderdikleri faturaların son durumunu bu metodu kullanarak sorgulamalıdırlar. Faturanın Hepsiburada e-Fatura 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": "QueryOutboxInvoiceStatus",
"parameters": {
"invoiceIds": [ "b7c6fa1b-1721-4859-8e57-a33ac96dc99c" ],
"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 da Response’un value alanı bir yada daha fazla InvoiceQueryStatus içeren bir liste/array olacaktır.
Tüm sorgulanan faturaların her birisi için bir adet InvoiceQueryStatus nesnesi Response.Value alanı içerisinde olacaktır.
InvoiceQueryStatus: Bir faturanın durumu hakkında bilgi içermektedir.
- InvoiceId: Durum bilgisi olan Faturanı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: Faturanın durumuna ait varsa eğer özel bir durum mesajı bu alanda dönecektir.
- Status: Faturanın durum bilgisi aşağıdakilerden biri olarak dönecektir. Eğer Faturada GIB’le olan iletişimden kaynaklı bir hata oluşması durumunda durumu Error olarak döner ve hatanın detaylı mesajı Message alanında verilir.
- Status Code: Faturanın durum kodu aşağıdakilerden biri olarak dönecektir. Eğer Faturada GIB’le olan iletişimden kaynaklı bir hata oluşması durumunda hata kodu 2000 olarak döner ve hatanın detaylı mesajı Message alanında verilir.
| Enum Değeri | Açıklama | Kod |
|---|---|---|
| Draft | Taslak | 0 |
| Canceled | İptal Edildi | 10 |
| Queued | Kuyrukta | 100 |
| Processing | İşlemde | 200 |
| SentToGib | GİB’e gönderildi | 300 |
| Approved | Onaylandı | 1000 |
| WaitingForApprovement | Onay Bekliyor | 1100 |
| Declined | Reddedildi | 1200 |
| Return | İade Edildi | 1300 |
| eArchiveCanceled | e-Arşiv İptal | 1400 |
| Error | Hata | 2000 |
