مستندات وب‌سرویس سرآور
ورود به داشبورد

مرجع api / commercial/companies/{nid}/capital-shares/

سهام‌داران فعلی

ترکیب فعلی سهام‌داران شرکت.

GETcommercial/companies/{national_id}/capital-shares/

سهام‌داران فعلی شرکت را برمی‌گرداند. هر ردیف ممکن است یک شخص حقیقی را به‌عنوان سهام‌دار شامل شود (در صورت موجود بودن و عدم وجود حریم‌خصوصی فعال).

نیازمند اعتبار20 درخواست در دقیقه

هدرها

X-API-KEYstringبله

کلید api شما.

پارامترهای کوئری

national_idstringبله

شناسه ملی شرکت.

idempotency_keystringبله

UUID یکتا.

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

curl -X GET 'https://saravar.com/api/commercial/companies/12345678901/capital-shares/?idempotency_key=550e8400-e29b-41d4-a716-446655440000' \
  -H 'X-API-KEY: <YOUR_API_KEY>'

پاسخ

debit_transaction_idinteger | nullبله

شناسه تراکنش.

total_chargedintegerبله

مبلغ کسر شده بر حسب IRR.

dataShareholder[]بله

آرایه‌ای از { id, total_value, number_of_shares, percentage, is_current, person? }. فیلد person در صورتی شامل می‌شود که سهام‌دار شخص حقیقی باشد و حریم‌خصوصی فعال نداشته باشد.

نکات قیمت‌گذاری و رفتار

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

خطاها

400کد وضعیت
علتidempotency_key مفقود یا insufficient_credits.
اقدام پیشنهادیکلید معتبر ارسال کنید یا شارژ کنید.
401کد وضعیت
علتکلید api نامعتبر است.
اقدام پیشنهادیکلید فعال بسازید.
403کد وضعیت
علتاحراز هویت ملی تکمیل نشده.
اقدام پیشنهادیاحراز هویت را تکمیل کنید.
404کد وضعیت
علتشرکت یافت نشد.
اقدام پیشنهادیشناسه ملی را بررسی کنید.
429کد وضعیت
علتاز سقف نرخ عبور کرده‌اید.
اقدام پیشنهادیbackoff اعمال کنید.