Belge kredilerini oku

{
  "status": true,
  "result": [
    {
      "EndDate": "2027-01-01T00:00:00Z",
      "Name": "E-Fatura",
      "ModuleID": 1,
      "RemainingCredit": 250
    }
  ],
  "isMuhasip": false
}

{
  "status": false,
  "message": "İstek alanları geçersiz."
}

{
  "status": false,
  "code": "UNAUTHORIZED",
  "message": "API kimlik bilgileri doğrulanamadı."
}

{
  "status": false,
  "message": "Ürün, IP, modül izni veya kaynak kapsamı uygun değil."
}

{
  "status": false,
  "message": "<string>",
  "description": "<string>",
  "result": "<unknown>"
}

{
  "status": false,
  "message": "<string>",
  "description": "<string>",
  "result": "<unknown>"
}

{
  "status": 429,
  "error": "Too Many Requests",
  "message": "Rate limit exceeded. Please try again later."
}

{
  "status": false,
  "message": "İşlem gerçekleştirilemedi."
}

GET

https://api.muhasip.pro

apps

invoice

credit

{
  "status": true,
  "result": [
    {
      "EndDate": "2027-01-01T00:00:00Z",
      "Name": "E-Fatura",
      "ModuleID": 1,
      "RemainingCredit": 250
    }
  ],
  "isMuhasip": false
}

{
  "status": false,
  "message": "İstek alanları geçersiz."
}

{
  "status": false,
  "code": "UNAUTHORIZED",
  "message": "API kimlik bilgileri doğrulanamadı."
}

{
  "status": false,
  "message": "Ürün, IP, modül izni veya kaynak kapsamı uygun değil."
}

{
  "status": false,
  "message": "<string>",
  "description": "<string>",
  "result": "<unknown>"
}

{
  "status": false,
  "message": "<string>",
  "description": "<string>",
  "result": "<unknown>"
}

{
  "status": 429,
  "error": "Too Many Requests",
  "message": "Rate limit exceeded. Please try again later."
}

{
  "status": false,
  "message": "İşlem gerçekleştirilemedi."
}

Ne yapar?

Bağlı e-belge hesabının modül bazında kalan kredi bilgisini döndürür. E-belge bağlantısı önceden kurulmuş olmalıdır. Yan etkiler: Kalıcı mali kayıt oluşturmaz. Sonraki adım: Dönen sonucu kaydedin veya ilgili detay kaynağını okuyun.

Ön koşullar ve izin

Etkin API anahtarı ve muhasip:invoice:read izni gerekir. İlişkili kayıtlar aynı firmaya ait olmalıdır. Erişim ayarları için kimlik ve izinler rehberini inceleyin. İstek ve cevap şemalarını indirin.

İstek örnekleri

Örnekler temsilîdir. Kimlikleri, belge tarihlerini ve iş verisini kendi yetkili kayıtlarınızla değiştirin. Node.js örnekleri Node.js 20 veya üzeri içindir; PHP örnekleri cURL uzantısını kullanır. Hiçbiri otomatik tekrar yapmaz.

curl --request GET 'https://api.muhasip.pro/apps/invoice/credit' \
  --user "$MUHASIP_API_USER_ID:$MUHASIP_API_SECRET" \
  --header 'Accept: */*'

<?php
$apiUserId = getenv('MUHASIP_API_USER_ID');
$secretKey = getenv('MUHASIP_API_SECRET');
if (!$apiUserId || !$secretKey) {
    throw new RuntimeException('API kimlik bilgileri eksik.');
}
$headers = ['Accept: */*'];
$handle = curl_init('https://api.muhasip.pro/apps/invoice/credit');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_CONNECTTIMEOUT => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTPAUTH => CURLAUTH_BASIC,
    CURLOPT_USERPWD => $apiUserId . ':' . $secretKey,
]);
$response = curl_exec($handle);
$httpStatus = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
curl_close($handle);
if ($response === false) {
    throw new RuntimeException('Bağlantı tamamlanamadı; mali işlemi otomatik tekrarlamayın.');
}
if ($httpStatus < 200 || $httpStatus >= 300) {
    throw new RuntimeException('HTTP ' . $httpStatus . '; kaynak hata açıklamasını değerlendirin.');
}
// $response gövdesini bu işlemin cevap biçimine göre işleyin; ham cevabı loglamayın.
echo 'HTTP ' . $httpStatus . PHP_EOL;

async function main() {
  const apiUserId = process.env.MUHASIP_API_USER_ID
  const secretKey = process.env.MUHASIP_API_SECRET
  if (!apiUserId || !secretKey) throw new Error("API kimlik bilgileri eksik.")
  const response = await fetch("https://api.muhasip.pro/apps/invoice/credit", {
    method: "GET",
    redirect: "manual",
    headers: {
      Accept: "*/*",
      Authorization: "Basic " + Buffer.from(`${apiUserId}:${secretKey}`).toString("base64")
    },
    signal: AbortSignal.timeout(30000)
  })
  const data = await response.arrayBuffer()
  if (!response.ok) throw new Error(`HTTP ${response.status}; kaynak hata açıklamasını değerlendirin.`)
  // data gövdesini bu işlemin cevap biçimine göre işleyin; ham cevabı loglamayın.
  console.log("HTTP", response.status)
}

main().catch(() => {
  console.error("İstek tamamlanamadı; mali işlemi otomatik tekrarlamayın.")
  process.exitCode = 1
})

Cevabı değerlendirin

Önce HTTP durumunu, ardından bu kaynağın status ve sonuç alanlarını değerlendirin. Bütün uçlar aynı sonuç zarfını veya oluşturma için 201 kodunu kullanmaz. Temsilî başarılı cevap; gerçek hizmet çağrısından alınmamıştır:

{
  "status": true,
  "result": [
    {
      "EndDate": "2027-01-01T00:00:00Z",
      "Name": "E-Fatura",
      "ModuleID": 1,
      "RemainingCredit": 250
    }
  ],
  "isMuhasip": false
}

Hata durumunda

HTTP	Bu işlemde anlamı	İzlenecek adım
400	İstek alanları geçersiz.	Alan adını, türünü ve zorunluluğunu kontrol edin; değişmeyen hatalı isteği tekrar göndermeyin.
401	API kimliği/parolası, erişim süresi veya firma doğrulanamadı.	Anahtar kimliğini, gizli değeri, erişim süresini ve firma erişimini kontrol edin.
403	API izni, IP kısıtı veya kayıt erişimi uygun değil.	Anahtarın izinlerini, IP kısıtını ve kayıt kimliğini kontrol edin.
411	İş kuralı, bağlantı veya kaynak hizmet hatası. message, description veya result alanı gelebilir.	Kaynak iş koşulunu ve varsa sağlayıcı sonucunu kontrol edin.
412	İşlem tamamlanamadı. Genel message ve description alanları dönebilir.	Kaynak iş koşulunu ve hizmet sonucunu inceleyin; mali etkiyi yalnız HTTP kodundan çıkarmayın.
429	Ortak istek sınırı aşıldı; sayısal status alanı kullanılır.	Varsa Retry-After bilgisini değerlendirin. Mali çağrıyı otomatik yeniden göndermeyin.
500	İşlem gerçekleştirilemedi.	İşlem sonucunu inceleyin; bağlantı/hata oluşması mali etkinin hiç başlamadığını kanıtlamaz.

Ağ kesintisi, zaman aşımı veya JSON olmayan cevap mali etkinin oluşmadığını kanıtlamaz. Ham istek/cevapları genel loglara yazmayın. Hata yönetimi

Sonraki adım

Dönen kimlik ve durumları saklayın; iş akışınızın ilgili detay veya yazma adımında kullanın. Kaynak akışı · İşlem takibi · Kapsam ve sınırlamalar

Yetkilendirmeler

Authorization

string

header

gerekli

Kullanıcı adı apiUserId, parola secretKey. Aktif ve süresi geçmemiş API kullanıcısı ve uygun firma gerekir.

Yanıt

İşlem tamamlandı. Örnek değerler temsilîdir.

status

boolean

gerekli

result

object[]

gerekli

Show child attributes

isMuhasip

boolean

gerekli

Servis ve uygulamalar

Fatura ve e-belge

Banka hesapları ve hareketleri

Banka otomasyonları

İş akışları ve alanlar

POS ve tahsilat

GİB e-Arşiv

Pazaryeri

Online işlemler

Proje ve görevler

Ajanda

Takvim

Mali işlem durumu

Belge kredilerini oku

Ne yapar?

Ön koşullar ve izin

İstek örnekleri

Cevabı değerlendirin

Hata durumunda

Sonraki adım

Yetkilendirmeler

Yanıt

​Ne yapar?

​Ön koşullar ve izin

​İstek örnekleri

​Cevabı değerlendirin

​Hata durumunda

​Sonraki adım

Yetkilendirmeler

Yanıt

Ne yapar?

Ön koşullar ve izin

İstek örnekleri

Cevabı değerlendirin

Hata durumunda

Sonraki adım