Skip to main content
#P1407

POST /api/v2/trade/operation/general

Route Info

Method Endpoint Controller Middleware Purpose
POST /api/v2/trade/operation/general V2TradeController@generalTrade authWithJwt دریافت گزارش جامع و تحلیلی از فاکتور انتخابی از طریق Controller مرکزی StaticController

منطق عملکرد

  • ابتدا شناسه داخلی فاکتور از جدول factors با اختلاف ReferenceExtension محاسبه می‌شود.
  • سپس تابع StaticController::generalTrade() برای شناسه مربوطه اجرا و خروجی مستقیماً return می‌شود.
  • نتیجه، شامل خلاصه‌ای از وضعیت مالی و خدماتی فاکتور است که برای استفاده در داشبوردها و ماژول‌های حسابداری گزارش‌گیری طراحی شده.

پارامترهای ورودی

نام نوع ضروری توضیح
id integer بله شناسه سریال مرجع جهت محاسبه ID داخلی
{ "id": 23051 }

خروجی

خروجی برابر با مقدار بازگردانده‌شده از StaticController::generalTrade() است. شامل گزارش مالی تفصیلی، وضعیت گردش حساب فاکتور و اقلام مرتبط.

{
  "financial": { ... },
  "operations": [ ... ],
  "summary": { "total_buy": ..., "total_sell": ... }
}

وابستگی‌ها

  • DB::table('factors')
  • StaticController::generalTrade()
  • Carbon\Carbon

امنیت

  • نیازمند JWT معتبر و فعال بودن دسترسی شعبه بر روی فاکتور مورد درخواست.

کارایی

  • میانگین زمان پاسخ کمتر از ۱۸۰ms (داده تک‌مرحله‌ای).
  • وابسته به کارایی تابع StaticController::generalTrade().

مدیریت خطا

  • در صورت عدم وجود فاکتور، خروجی Null یا Exception داخلی از StaticController return می‌شود.

پیشنهادهای بهبود

  • رفع وابستگی مستقیم به $this->ReferenceExtension برای ماژول‌های عمومی.
  • هم‌راستا کردن خروجی با قالب JSON گسترده‌ی operationTrade برای توسعه داشبورد واحد.

جمع‌بندی

این Endpoint، نسخه‌ی ساده‌شده و سریع‌تر از operationTrade است که خروجی تجمیعی (general) را با حداقل منطق کنترلی برمی‌گرداند. برای پردازش سریع و استفاده در بخش‌های تحلیلی سمت سرور یا گزارش‌های مالی طراحی شده است.