nptak-tax / API مستندات منتشر شده

برای توسعه‌دهندگان نرم‌افزارهای حسابداری

مستندات اتصال به nptak-tax

دریافت دسته‌ای صورتحساب‌ها، پیگیری درخواست‌ها و ارتباط با سامانه مؤدیان از طریق یک API مشترک.

قرارداد عمومی: نسخه ۱زبان رابط: فارسیJSON · HTTPS

این انتشار، پیش‌نمایش مستندات است.

مستندات آنلاین است؛ سرویس عمومی پذیرش و ارسال صورتحساب هنوز فعال نشده است. مسیرهای مرجع زیر در هسته پیاده‌سازی شده‌اند، اما فعال‌سازی دسترسی شرکا و ارسال واقعی پس از تکمیل و آزمون مراحل بعد انجام می‌شود.

مستندات و فایل قراردادقابل دریافت
API عمومی شرکادر آماده‌سازی
ارسال واقعی به مؤدیانفعال نشده

فعلاً درخواست صورتحساب یا اطلاعات محرمانه به این دامنه ارسال نکنید. نمونه‌های این صفحه برای بررسی قرارداد هستند.

۰۱

احراز هویت و دسترسی

هر نرم‌افزار حسابداری یک توکن مستقل دریافت می‌کند. توکن فقط به همان شریک و مجوزهای تأییدشدهٔ او تعلق دارد. شناسه پروفایل به‌تنهایی مجوز دسترسی ایجاد نمی‌کند.

الگوی سربرگ
Authorization: Bearer <partner-token>

توکن نرم‌افزار حسابداری

برای احراز هویت درخواست‌های API است و قابلیت تعیین دامنه دسترسی، انقضا و لغو دارد.

اعتبارنامه امضای مؤدی

به هویت مالیاتی مؤدی تعلق دارد. دریافت و نگهداری آن از روند کنترل‌شدهٔ اعتبارنامه انجام خواهد شد؛ کلید خصوصی در درخواست معمول صورتحساب قرار نمی‌گیرد.

یک مؤدی می‌تواند به چند نرم‌افزار حسابداری مجوز بدهد. پروفایل‌ها و دسترسی هر شریک مستقل می‌ماند؛ شماره‌گذاری حافظه مالیاتی میان نویسندگان مجاز باید هماهنگ باشد.

۰۲

مرجع قرارداد فعلی

این بخش مستقیماً از فایل OpenAPI تولیدشدهٔ هسته خوانده می‌شود و فقط مسیرهای پیاده‌سازی‌شده را نشان می‌دهد. نمایش یک مسیر در قرارداد به معنی فعال بودن آن روی این دامنه نیست.

نشانی برنامه‌ریزی‌شدهٔ API
https://tax.didis.ir/api/v1
در حال خواندن فایل قرارداد…
۰۳

روند ارسال صورتحساب

پیش‌نویس

قرارداد نهایی ارسال پس از تکمیل صف پایدار و تطبیق قواعد هر الگو منتشر می‌شود. نمونه زیر فقط شکل کلی تبادل را توضیح می‌دهد و یک صورتحساب معتبر مالیاتی نیست.

  1. انتخاب پروفایل مؤدیاطلاعات ثابت از پروفایل و نسخه مشخص آن خوانده می‌شود.
  2. دریافت رسید داخلیپس از ذخیره پایدار، شناسه دسته و درخواست‌های آن بازگردانده می‌شود.
  3. پردازش در صفسامانه اعتبارسنجی، ارسال و استعلام را با محدودیت منابع و مجوزها انجام می‌دهد.
  4. پیگیری وضعیتنرم‌افزار نتیجه ثبت‌شدهٔ هر درخواست را با شناسه داخلی دریافت می‌کند.
درخواست پیشنهادی — هنوز فعال نیست
POST /api/v1/submissions
Idempotency-Key: erp-example-001

{
  "profile_id": "prf_example",
  "documents": [
    {
      "external_id": "sale-example",
      "operation": "original",
      "invoice": { "…": "…" }
    }
  ]
}
شکل رسید پیشنهادی
HTTP/1.1 202 Accepted

{
  "submission_id": "sub_example",
  "profile_id": "prf_example",
  "profile_revision_id": "prv_example",
  "items": [
    {
      "request_id": "req_example",
      "state": "queued"
    }
  ]
}

رسید 202 یعنی درخواست در سامانه ما به‌طور پایدار پذیرفته شده است. تأیید ثبت در سامانه مؤدیان، وضعیت جداگانه‌ای است.

اصل، اصلاح، ابطال و برگشت از فروش در دامنه محصول قرار دارند. عملیات اصلاحی یک سند مرتبط جدید می‌سازد؛ اطلاعات صورتحساب ثبت‌شده در جای خود بازنویسی نمی‌شود.

۰۴

خطاها و پیگیری

کد HTTPمعنی در قرارداد
401توکن غایب، نامعتبر، منقضی یا لغوشده است.
403دامنه دسترسی توکن برای این عملیات کافی نیست.
404منبع در محدوده دسترسی فراخواننده در دسترس نیست.
409تعارض نسخه، شناسه خارجی یا کلید تکرار؛ در قرارداد عملیات نوشتن.
429 / 503محدودیت ظرفیت یا توقف پذیرش؛ راهنمای تلاش مجدد همراه پاسخ ارائه خواهد شد.

کدهای ماشینی انگلیسی و توضیحات کاربر فارسی هستند. شناسه همبستگی پاسخ برای پیگیری خطا استفاده می‌شود. قطع ارتباط به‌تنهایی ثابت نمی‌کند که ارسال به مؤدیان انجام نشده؛ بازیابی نتیجه پیش از تصمیم به ارسال مجدد لازم است.

مبالغ و تعدادها در قرارداد مالی به‌صورت رشتهٔ ده‌دهی با واحد صریح مشخص می‌شوند؛ زمان API با UTC و پسوند Z ارائه می‌شود. نمایش تاریخ شمسی و منطقه زمانی تهران در رابط فارسی انجام خواهد شد.

۰۵

مسیر راه‌اندازی

✓

هسته و مستنداتهویت شرکا، مجوزها، پروفایل‌ها و API خواندنی؛ پیش‌نمایش مستندات آنلاین

انجام شده
۲

پذیرش پایدار و اعتبارنامهذخیره رمز‌شده، جلوگیری از تکرار، صف و بازیابی خطا

در حال توسعه
۳

تطبیق با مؤدیان و پایلوت شرکاآزمون شناسه، امضا، قواعد الگوها و ارسال کنترل‌شده

مرحله بعد
۴

گسترش پوشش و داشبوردعملیات و الگوهای مستند، شرکای بیشتر و خدمات مستقیم کاربران

برنامه‌ریزی‌شده

زمان فعال‌سازی پذیرش واقعی با عبور از آزمون‌های یکپارچگی، بازیابی و تطبیق مشخص می‌شود. تاریخ قطعی برای این مرحله هنوز اعلام نشده است.