Skip to main content
#P1610

GET /v2/accounting/preference

Route Info

Method Endpoint Controller Middleware
GET /v2/accounting/preference AccountingController@indexMappingPreferences authWithJwt

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

این مسیر برای دریافت لیست نگاشت حسابداری استفاده می‌شود. اطلاعات جدول mapping_accounting_preferences را بر اساس شعبه، نوع شیء (object_type) و شناسه شیء (object) به‌صورت صفحه‌بندی شده (Paginated) برمی‌گرداند.

در صورت نبود پارامتر paginate، سیستم به‌صورت خودکار مقدار پیش‌فرض زیر را اعمال می‌کند:

  • length = 30
  • start = 0

محاسبه شماره صفحه بر اساس فرمول زیر انجام می‌شود:

page = (start == 0 ? length : start + length) / length

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

  • branch شناسه شعبه (اجباری)
  • object_type نوع شیء هدف (اختیاری) مثال: customer, colleague, office
  • object شناسه شیء هدف (اختیاری)
  • paginate[length] تعداد رکورد در هر صفحه (پیش‌فرض 30)
  • paginate[start] شماره شروع (Offset) — پیش‌فرض 0

پاسخ موفق (Success Response)

پاسخ شامل داده‌های صفحه‌بندی‌شده لاراول است (object کامل pagination):

{
  "payload": {
    "current_page": 1,
    "data": [
      {
        "id": 12,
        "branch": 1,
        "object_type": "customer",
        "object": 24,
        "moeen": 14,
        "created_at": "2024-07-21T10:00:00.000000Z",
        "updated_at": "2024-07-21T10:00:00.000000Z"
      }
    ],
    "first_page_url": "...",
    "from": 1,
    "last_page": 4,
    "last_page_url": "...",
    "next_page_url": "...",
    "path": "...",
    "per_page": 30,
    "prev_page_url": null,
    "to": 30,
    "total": 110
  },
  "meta": {
    "timestamp": 1733056000
  }
}

خطاها (Errors)

  • این مسیر خطای اختصاصی ندارد.
  • در صورت نبود داده، مقدار payload برابر false خواهد بود.

وابستگی دیتابیس

Table Description
mapping_accounting_preferences جدول نگاشت حسابداری برای انواع موجودیت‌ها

Meta

  • HTTP Status: 200
  • Pagination: فعال
  • فیلتر پویا بر اساس object_type و object