در حال بارگذاری ...
API ایجاد شخص در کاریا حساب این امکان را فراهم میکند که توسعهدهندگان بتوانند مشتریان، تامینکنندگان، کارکنان، تنخواهداران و سایر اشخاص را بهصورت مستقیم از نرمافزارهای دیگر مانند فروشگاه اینترنتی، CRM، ERP و سیستمهای داخلی در نرمافزار حسابداری کاریا ثبت کنند.
این وب سرویس برای اتصال سیستمهای خارجی به کاریا حساب طراحی شده و در ثبت اطلاعات مالی، صدور فاکتور، عملیات حسابداری، دریافت و پرداخت، حواله انبار و مدیریت طرف حسابها کاربرد دارد.
اگر قصد اتصال سایت، اپلیکیشن یا نرمافزار اختصاصی خود به API کاریا حساب را دارید، این مستندات تمامی اطلاعات موردنیاز برای ثبت شخص در سیستم حسابداری کاریا را در اختیار شما قرار میدهد.
API تعریف شخص در کاریا حساب چیست؟
وب سرویس تعریف شخص (Person Endpoint) یکی از مهمترین API های نرمافزار حسابداری کاریا است که برای ایجاد طرف حساب جدید در سیستم مالی استفاده میشود.
با استفاده از این API میتوانید:
- مشتری جدید ثبت کنید
- تامین کننده ایجاد کنید
- کارمند تعریف کنید
- تنخواهدار ثبت کنید
- اطلاعات اشخاص را از CRM به حسابداری منتقل کنید
- اتصال فروشگاه اینترنتی به کاریا حساب را انجام دهید
آدرس API ثبت شخص در کاریا حساب
Request Method
POST
API URL
https://panel.kariyahesab.com/DefinitionEndpoint/customer
احراز هویت در API کاریا حساب
برای استفاده از API کاریا حساب باید هدر Authorization در تمامی درخواستها ارسال شود.
نمونه Header
Authorization: {API_TOKEN}
توکن احراز هویت توسط تیم فنی کاریا حساب در اختیار توسعهدهندگان قرار میگیرد.
پیش نیاز فعال سازی API کاریا حساب
قبل از استفاده از وب سرویسهای کاریا حساب باید دسترسی API برای میزکار شما فعال شود.
برای فعال سازی API لازم است درخواست رسمی برای تیم پشتیبانی کاریا ارسال گردد.
اطلاعات موردنیاز برای فعال سازی API
- درخواست فعال سازی API
- آدرس IP سرور
- دامنه یا URL سیستم ارسال کننده درخواست
اطلاعاتی که توسط کاریا حساب ارائه میشود
- mizekar : شناسه میزکار
- mizekaruser : شناسه کاربر میزکار
- userid : شناسه کاربر
- fiscalyear : شناسه سال مالی فعال
- Authorization : توکن API
فرمت ارسال اطلاعات در API
Content Type
application/json
تمامی دادهها باید بهصورت JSON معتبر ارسال شوند.
پارامترهای API ایجاد شخص در کاریا حساب
فیلدهای پایه سیستم
mizekar
شناسه میزکار فعال در کاریا حساب.
mizekaruser
شناسه کاربر میزکار دارای دسترسی API.
userid
شناسه کاربری ثبت کننده اطلاعات.
fiscalyear
شناسه سال مالی فعال.
اطلاعات اصلی شخص
name
نام شخص یا شرکت.
- الزامی
- حداکثر 200 کاراکتر
address
آدرس شخص یا شرکت.
- اختیاری
- حداکثر 500 کاراکتر
shakhskind
نوع شخص در سیستم حسابداری کاریا.
1 = شخص حقوقی
2 = شخص حقیقی انفرادی
3 = شخص حقیقی مشارکت مدنی
4 = اتباع غیر ایرانی
5 = مصرف کننده نهایی
کد ملی و شناسه ملی
meli
این فیلد برای ثبت شناسه ملی، کد ملی یا شماره فراگیر استفاده میشود.
- شخص حقوقی: شناسه ملی 10 یا 11 رقمی
- شخص حقیقی: کد ملی 10 رقمی
- اتباع خارجی: شماره فراگیر 12 رقمی
- مصرف کننده نهایی: اختیاری
فقط مقدار عددی مجاز است.
کد اقتصادی
eghtesadi
کد اقتصادی شخص یا شرکت.
- حقوقی: شناسه ملی
- حقیقی انفرادی: 14 رقمی
- مشارکت مدنی: 12 رقمی
- اتباع خارجی: شماره فراگیر
در صورت خالی بودن یا نامعتبر بودن طول داده، API خطا برمیگرداند.
استعلام شناسه ملی: https://www.tax.gov.ir/action/do/InquiryNationalID
اطلاعات تماس
- ostan : استان
- shahrestan : شهرستان
- shahr : شهر
- tel : تلفن ثابت
- mobile : شماره موبایل
شماره ثبت شرکت
sabtnum
شماره ثبت فقط برای اشخاص حقوقی استفاده میشود.
- بین 3 تا 8 رقم
- اختیاری
کد پستی
codeposti
کد پستی باید 10 رقم عددی باشد.
برای ثبت اشخاص در سیستم حسابداری کاریا وارد کردن کد پستی الزامی است.
نوع طرف حساب
kindofwork
1 = تامین کننده
2 = مشتری
3 = کارمند
4 = تنخواه دار
الزامات ثبت اشخاص در API کاریا حساب
اشخاص حقوقی و حقیقی
برای اشخاص حقوقی، حقیقی و اتباع خارجی وارد کردن اطلاعات زیر الزامی است:
- نام
- کد ملی یا شناسه ملی
- کد اقتصادی
مصرف کننده نهایی
در حالت مصرف کننده نهایی فقط فیلد name الزامی است.
ثبت کارمند
برای تعریف کارمند وارد کردن کد ملی الزامی است.
ثبت تنخواه دار
برای تنخواهدار تمامی فیلدها اختیاری هستند.
نمونه JSON برای ثبت شخص در API کاریا حساب
{
"mizekar": 10,
"mizekaruser": 10,
"userid": 88718,
"fiscalyear": 5730,
"name": "شرکت نمونه حسابداری",
"address": "تهران، خیابان ولیعصر، پلاک ۱۲۳",
"shakhskind": "1",
"meli": "1234567890",
"eghtesadi": "411111111111",
"ostan": "تهران",
"shahrestan": "تهران",
"kindofwork": "2",
"sabtnum": "45879",
"shahr": "تهران",
"codeposti": "1234567890",
"tel": "02188776655",
"mobile": "09121234567"
}
نمونه پاسخ موفق API
{
"success": true,
"message": "شخص با موفقیت ثبت شد"
}
خطاهای متداول API
خطای Authorization
در صورت ارسال نکردن توکن API یا نامعتبر بودن آن، درخواست رد خواهد شد.
خطای کد ملی
در صورت وارد کردن کاراکتر غیرعددی یا تعداد رقم نامعتبر، API خطا برمیگرداند.
خطای کد اقتصادی
اگر طول کد اقتصادی صحیح نباشد عملیات ثبت شخص انجام نمیشود.
نظر شما برای ما مهم است