Skip to main content
#P1605

POST /v2/manual-document/list/{type}

Route Info

Method Endpoint Controller Method Middleware
POST /v2/manual-document/list/{type} AccountingController@listTypeManualDocument authWithJwt

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

این مسیر برای دریافت لیست ۵۰تایی اسناد دستی، افتتاحیه یا اختتامیه استفاده می‌شود. فیلتر جستجو از طریق پارامتر json اعمال می‌شود و خروجی شامل سریال نمایشی (+1000)، شماره سیستمی، و عنوان نهایی سند است.

  • خواندن رشته json و استخراج مقدار search.value
  • اگر مقدار جستجو عدد باشد → جستجو روی serial = value - 1000
  • اگر مقدار جستجو متن باشد → LIKE روی تاریخ و توضیحات
  • اعمال فیلتر branch
  • محدودسازی نوع به: manual، opening، closing
  • مرتب‌سازی نزولی بر اساس id
  • محدودیت خروجی: ۵۰ رکورد
  • تولید عنوان نهایی سند با استفاده از:
    getManualDocumentTitle(type, serial+1000, description, formattedDate)

پارامترهای مسیر (Path Parameters)

نام نوع توضیح
type string نوع سند (manual / opening / closing)

پارامترهای ورودی (JSON Body)

Body:

{
  "json": "{\"search\": {\"value\": \"1403/01\"}}",
  "branch": 1
}
  • json: رشته‌ای که شامل:
    • search.value: مقدار برای اعمال فیلتر عددی یا متنی
  • branch: شناسه شعبه

خروجی موفق (Success Response)

خروجی نهایی شامل آرایه‌ای از اسناد فرمت‌شده است:

{
  "status": true,
  "time": 1718451600,
  "data": [
    {
      "serial": 3125,
      "system_serial": 1524,
      "title": "سند شماره 3125 | 1403/01/21 | دستی - هزینه دفتر"
    },
    {
      "serial": 3101,
      "system_serial": 1512,
      "title": "سند شماره 3101 | افتتاحیه - افتتاح سال 1403"
    }
  ]
}

خروجی خطا (Error Response)

در صورت رخ دادن استثناء عمومی:

{
  "status": false,
  "time": 1718451600,
  "code": 5005,
  "message": "Exception message...",
  "trace": [ ... ]
}

الگوی ساخت عنوان سند (getManualDocumentTitle)

الگوی خروجی عنوان براساس نوع سند:

  • manual → سند شماره X | تاریخ | دستی - توضیحات
  • opening → سند شماره X | افتتاحیه - توضیحات
  • closing → سند شماره X | اختتامیه - توضیحات
  • daily_sales → مکانیزه فروش‌های روزانه
  • daily_credit_debit → مکانیزه دریافت/پرداخت روزانه

در این Route فقط سه نوع زیر بازگردانده می‌شود:

  • manual
  • opening
  • closing