Skip to main content
#P1588

GET /v2/wallet/balance

Route Info

Method Endpoint Controller
GET /v2/wallet/balance AccountingController@balanceWallet

شرح عملکرد (Functionality)

این متد وظیفه محاسبه تراز کیف پول (Wallet) را بر عهده دارد. بر اساس کدهای فعلی، این متد صرفاً موجودی کیف پول شعبه (ERP) را محاسبه می‌کند.

  • منطق محاسبه: جمع ستون‌های credit (بستانکار) و debit (بدهکار) از جدول wallet.
  • فیلترها:
    • رکوردهایی که status آن‌ها برابر 2 (احتمالا حذف شده/لغو شده) نباشد.
    • فیلد operator_type برابر با 'erp' باشد (ثابت در کد).
    • فیلد branch برابر با شناسه ارسالی (یا شناسه شعبه توکن جاری) باشد.
  • تشخیص ماهیت (Diagnosis): سیستم به صورت خودکار وضعیت تراز را به یکی از سه حالت creditor (بستانکار/مثبت)، debtor (بدهکار/منفی) یا neutral (بی‌حساب/صفر) تعیین می‌کند.

پارامترهای ورودی (Query String)

?type=office       // (بلااستفاده) به دلیل باگ داخلی نادیده گرفته می‌شود
&id=101            // (اختیاری) شناسه شعبه. اگر ارسال نشود از توکن کاربر خوانده می‌شود

خروجی (Response)

موفقیت (Success):

ساختار خروجی استاندارد شامل payload (داده اصلی) و meta (اطلاعات متا) است.

{
    "payload": {
        "credit": 15000000,       // مجموع ورودی‌ها
        "debit": 5000000,         // مجموع خروجی‌ها
        "balance": 10000000,      // مانده (credit - debit)
        "diagnosis": "creditor"   // وضعیت: creditor | debtor | neutral
    },
    "meta": {
        "timestamp": 1715780000
    }
}

خطا (Error):

{
    "status": false,
    "time": 1715780005,
    "message": "Error message here...",
    "trace": [...]
}