راهنمای api سامانه مودیان
راهنمای API سامانه مودیان، شامل توضیحات فنی در مورد نحوه اتصال نرمافزارهای مالی و حسابداری به این سامانه است.
راهنمای جامع API سامانه مودیان مالیاتی
سامانه مودیان مالیاتی برای تسهیل فرآیند ثبت و ارسال اطلاعات مالیاتی، APIهایی را ارائه کرده است . که کسبوکارها و توسعهدهندگان نرمافزار میتوانند از آنها برای اتصال سیستمهای خود به این سامانه استفاده کنند. این راهنما به بررسی جزئیات APIهای سامانه مودیان، نحوه احراز هویت، ارسال اطلاعات و استعلام وضعیت صورتحسابها میپردازد.
۱. پیشنیازهای فنی برای استفاده از API قبل از شروع کار با API سامانه مودیان، رعایت نکات زیر ضروری است:
- دریافت گواهی امضای دیجیتال برای ارسال درخواستهای معتبر
- دسترسی به توکن احراز هویت جهت استفاده از وبسرویسها
- استفاده از پروتکل HTTPS برای امنیت دادهها
- ارسال اطلاعات در قالب JSON یا XML مطابق استانداردهای مشخصشده
۲. دریافت توکن احراز هویت برای استفاده از APIهای سامانه مودیان، ابتدا باید یک توکن احراز هویت دریافت کنید:
- آدرس سرویس:
/api/v1/auth/token
- متد:
POST
- هدرها:
{ "Content-Type": "application/json" }
- بدنه درخواست:
{ "username": "your_username", "password": "your_password" }
- پاسخ نمونه:
{ "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "expiresIn": 3600 }
۳. ارسال صورتحساب الکترونیکی برای ارسال صورتحساب مالیاتی، از API مربوطه استفاده کنید:
- آدرس سرویس:
/api/v1/invoices/submit
- متد:
POST
- هدرها:
{ "Authorization": "Bearer {token}", "Content-Type": "application/json" }
- بدنه درخواست:
{ "invoiceNumber": "123456", "issueDate": "2024-02-08", "buyerTIN": "12345678901", "items": [ { "description": "کالا 1", "quantity": 2, "unitPrice": 500000, "taxAmount": 90000 } ] }
- پاسخ نمونه:
{ "status": "success", "trackingCode": "XYZ123456" }
۴. استعلام وضعیت صورتحسابها پس از ارسال صورتحساب، میتوان وضعیت آن را بررسی کرد:
- آدرس سرویس:
/api/v1/invoices/status
- متد:
GET
- پارامترهای ورودی:
trackingCode=XYZ123456
- پاسخ نمونه:
{ "invoiceNumber": "123456", "status": "Accepted", "processingTime": "2024-02-08T12:00:00Z" }
۵. دریافت گزارش مالیاتی مودیان مالیاتی میتوانند گزارشهای مالیاتی خود را از طریق API دریافت کنند:
- آدرس سرویس:
/api/v1/reports/tax-summary
- متد:
GET
- پاسخ نمونه:
{ "taxpayerTIN": "12345678901", "totalInvoices": 150, "totalTaxAmount": 50000000 }
۶. خطاهای رایج و راهحلها
کد خطا | توضیح | راهحل |
---|---|---|
401 | احراز هویت ناموفق | بررسی توکن دسترسی |
403 | دسترسی غیرمجاز | بررسی سطح دسترسی کاربر |
422 | اطلاعات ورودی نامعتبر | بررسی قالب درخواست |
500 | خطای داخلی سرور | تماس با پشتیبانی سازمان امور مالیاتی |
۷. نتیجهگیری
APIهای سامانه مودیان مالیاتی به کسبوکارها کمک میکنند تا فرآیند ارسال و مدیریت صورتحسابهای مالیاتی خود را بهصورت خودکار انجام دهند. رعایت استانداردهای تعیینشده و استفاده صحیح از توکن احراز هویت، باعث افزایش امنیت و دقت در ارسال اطلاعات خواهد شد.