پرش به مطلب اصلی

گزارش مالی (Financial History)

این گزارش اطلاعات مربوط به تراکنش‌های مالی را نمایش می‌دهد و قابلیت جست‌وجو بر اساس بازه زمانی را دارد.


اطلاعات عمومی

  • آدرس: /api/v3/financial/history
  • متد: POST
  • نوع خروجی: application/json
  • احراز هویت: نیازمند token

پارامترهای بدنه درخواست (Body)

نام پارامترنوعتوضیحات
pageintegerشماره صفحه
date_minintegerحداقل تاریخ فیلتر شده (timestamp)
date_maxintegerحداکثر تاریخ فیلتر شده (timestamp)

نمونه درخواست

curl -X POST "https://corporate.snapp.site/api/v3/financial/history" \
-H "Authorization: <your_authorization_token>" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
--data-raw '{"page":1,"date_max":1740515400,"date_min":1739910600}'

پاسخ موفق

{
"status": 200,
"data": {
"transactions": [
{
"transaction_type": 55,
"transaction_reference": "string",
"creditor": 3500000,
"debtor": 0,
"description": "string",
"current_balance": 0,
"created_at": "string",
"date_time": "string"
}
]
}
}

کدهای وضعیت و خطاها

کد وضعیتتوضیحات
200درخواست با موفقیت انجام شد
400درخواست نامعتبر است (مثلاً پارامترهای نامعتبر ارسال شده‌اند)
401عدم احراز هویت (توکن JWT نامعتبر یا منقضی‌شده است)
403دسترسی غیرمجاز
500خطای داخلی سرور