api مستندات وب‌سرویس تعریف کالا و خدمات در نرم‌افزار کاریا حساب

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

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

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

آدرس وب‌سرویس

https://panel.kariyahesab.com/DefinitionEndpoint/product

متد درخواست

POST

Authentication (احراز هویت)

برای استفاده از این API باید توکن دسترسی در هدر درخواست ارسال شود.

Headers

Authorization: YOUR_API_TOKEN

مقدار Authorization توسط تیم پشتیبانی کاریا در زمان فعال‌سازی API در اختیار شما قرار می‌گیرد.

Body درخواست (اطلاعات کالا یا خدمات)

تمام اطلاعات کالا یا خدمات باید در بخش Body و به‌صورت JSON ارسال شود.

این اطلاعات شامل پارامترهای سیستمی و پارامترهای مربوط به کالا یا خدمات است.

پارامترهای سیستمی

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

mizekar

شناسه میزکار فعال

mizekaruser

شناسه کاربر میزکار

userid

شناسه کاربر ثبت‌کننده اطلاعات

fiscalyear

شناسه سال مالی فعال

پارامترهای تعریف کالا و خدمات

نوع کالا یا خدمات

kalaorkhad

این فیلد مشخص می‌کند آیتم ثبت‌شده کالا است یا خدمات.

مقادیر مجاز:

1 = کالا
2 = خدمات

این فیلد الزامی است.

کد کالا

kalacode

کد کالا باید فقط به‌صورت عددی وارد شود.

• فقط عدد مجاز است
• حداقل 1 رقم
• حداکثر 10 رقم
• الزامی

نام کالا یا خدمات

name

نام کالا یا خدماتی که در سیستم ثبت می‌شود.

• فقط متن
• حداکثر 250 کاراکتر
• الزامی

شناسه کالا

shenasekala

شناسه کالا باید به‌صورت عدد 13 رقمی وارد شود.

• فقط عدد
• دقیقا 13 رقم
• الزامی

درصد ارزش افزوده

arzeshafzode

درصد مالیات یا ارزش افزوده مربوط به کالا یا خدمات.

• عدد بین 0 تا 99
• الزامی

قیمت کالا یا خدمات

price

در صورت نیاز می‌توان قیمت کالا یا خدمات را در این فیلد وارد کرد.

• عددی
• اختیاری

توضیحات

des

این فیلد برای ثبت توضیحات مربوط به کالا یا خدمات استفاده می‌شود.

• اختیاری

واحد اندازه‌گیری

measurement_units

برای ثبت کالا یا خدمات باید کد واحد اندازه‌گیری ارسال شود. این کد از ابزار «واحد اندازه‌گیری» در سیستم کاریا دریافت می‌شود.

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

این فیلد الزامی است.

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

{
  "mizekar": 10,
  "mizekaruser": 10,
  "userid": 88718,
  "fiscalyear": 5730,
  "name": "کالا",
  "kalacode": "12334566",
  "kalaorkhad": "1",
  "price": "10000",
  "des": "abcd",
  "shenasekala": "4111111111111",
  "measurement_units": "6214",
  "arzeshafzode": "10"
}

نمونه کامل درخواست HTTP

POST /ProductEndpoint HTTP/1.1
Host: panel.kariyahesab.com
Authorization: YOUR_API_TOKEN
Content-Type: application/json

{
  "mizekar": 10,
  "mizekaruser": 10,
  "userid": 88718,
  "fiscalyear": 5730,
  "name": "کالا",
  "kalacode": "12334566",
  "kalaorkhad": "1",
  "price": "10000",
  "des": "abcd",
  "shenasekala": "4111111111111",
  "measurement_units": "6214",
  "arzeshafzode": "10"
}

کاربردهای وب‌سرویس تعریف کالا و خدمات

این API برای یکپارچه‌سازی نرم‌افزار کاریا حساب با سایر سیستم‌ها استفاده می‌شود. برخی از کاربردهای آن عبارتند از:

• اتصال فروشگاه اینترنتی به نرم‌افزار حسابداری
• ثبت خودکار کالاها در سیستم مالی
• مدیریت خدمات در سیستم‌های سازمانی
• همگام‌سازی اطلاعات کالا بین چند نرم‌افزار
• کاهش ورود دستی اطلاعات در نرم‌افزار حسابداری

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

سوالات متداول