پارامترهای ورودی

نام پارامتر

نوع پارامتر

توضیحات

userName

string

این پارامتر نام کاربری کاربر مورد نظر را جهت بررسی دریافت می نماید.

password

string

این پارامتر رمز عبور کاربر مورد نظر را جهت بررسی دریافت می نماید.

productInfo

ProductInfo

این پارامتر که از نوع کلاس ProductInfo می باشد تمامی اطلاعات مربوط به محصول مورد نظر را برای ثبت در پایگاه داده دریافت می نماید.

فیلدهای کلاس ProductInfo

نام

نوع

توضیحات

Name

string

نام محصول در این پارامتر مشخص می گردد.

Code

string

کد محصول در این پارامتر مشخص می گردد.

GroupName

string

عنوان گروه محصول در این پارامتر مشخص می گردد.

IsService

bool?

در صورتی که نوع محصول مورد نظر خدمت باشد می توان به این پارامتر مقدار True را ارسال نمود.

UnitBuyPrice

decimal?

قیمت خرید محصول در این پارامتر مشخص می گردد.

UnitPrice

decimal?

قیمت واحد محصول در این پارامتر مشخص می گردد.

ProductUnitType

string

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

TechInfo

string

اطلاعات فنی محصول در این پارامتر مشخص می گردد.

Description

string

توضیحات مربوط به محصول در این پارامتر مشخص می گردد.

RefId

string

این فیلد برای ارجاعات احتمالی به CrmObject استفاده می گردد.

Commision

Decimal?

پورسانت فروش محصول در این پارامتر مشخص می گردد.

CommisionType

string

نوع پورسانت فروش محصول بصورت "رقم" یا "درصد" در این پارامتر مشخص می گردد.

Sellable

bool?

قابل فروش بودن محصول در این پارامتر مشخص می گردد.

Inventory

bool?

در صورتی که به این پارامتر مقدار true ارسال گردد، محصول دارای قابلیت های انبارداری شده و می توان برای آن تعداد ورود و خروج به انبار و سایر عملیات مرتبط با آن را انجام داد.

Brand

string

عنوان برند محصول در این پارامتر مشخص می گردد.

MadeIn

string

نام کشور ساخت محصول در این پارامتر مشخص می گردد.

Taxable

bool?

در صورتی که به این پارامتر مقدار true ارسال شود، اعمال مالیات بر روی محصول مورد نظر امکان پذیر می گردد.

Tollable

bool

در صورتی که به این پارامتر مقدار true ارسال شود، اعمال عوارض بر روی محصول مورد نظر امکان پذیر می گردد.

IsCommission

bool?

این مقدار تعیین می کند که پورسانت بر روی این محصول محاسبه گردد یا خیر. لازم به ذکر است در صورتی که مقدار و نوع پورسانت برای محصول در نظر گرفته نشده باشد، مقدار این فیلد بصورت پیش فرض false خواهد بود.

PriceListInfo

PriceListInfo

این پارامتر که از نوع کلاس PriceListInfo می باشد تمامی اطلاعات مربوط به لیست قیمت مورد نظر را برای نمایش از پایگاه داده دریافت می نماید و با عدم فعال بودن ماژول لیست قیمت مقداری در لیست قیمت برگردانده نمی‌شود(آبجکت جاری فقط خواندنی است و در متد ذخیره کاربردی ندارد).

فیلدهای کلاس PriceListInfo

نام

نوع

توضیحات

Name

string

نام لیست قیمت در این پارامتر مشخص می گردد.

InvoiceType

string

نوع فاکتور در این پارامتر مشخص می گردد.

·         برای فاکتور فروش و پیش فاکتور فروش مقدار "فاکتور فروش"

·         برای فاکتور خرید و پیش فاکتور خرید مقدار "فاکتور خريد"

·         برای فاکتور برگشت از فروش مقدار "فاکتور برگشت از فروش"

·         و برای فاکتور برگشت از خرید مقدار "فاکتور برگشت از خريد"

PriceListProducts

List<PriceListProductInfo>

لیستی از قیمت ها برای هر محصول در این پارامتر مشخص می گردد.

فیلدهای کلاس PriceListProductInfo

نام

نوع

توضیحات

PricingType

string

سیاست قیمت گذاری در این پارامتر مشخص می گردد.

Amount

decimal

به کمک مشخصه PricingType قیمت اعمال شده این پارامتر مشخص می گردد.

ProductId

Guid

شناسه محصول را مشخص می کند.

ProductCode

string

کد محصول را مشخص می کند.

مقدار بازگشتی

نام پارامتر

نوع پارامتر

توضیحات

SaveCrmObjectResult

object

نوع خروجی این متد یک object از نوع SaveCrmObjectResult است که دارای دو ویژگی Message و Success می باشد.

·         ویژگی Message پیغامی مبنی بر عدم موفقیت ذخیره اطلاعات را به همراه شرح خطا باز می‌گرداند.

·         ویژگی Success مقداری از نوع bool مبنی بر موفقیت یا عدم موفقیت نهایی در عملکرد وب سرویس را باز می‌گرداند.

پارامترهای ورودی

نام پارامتر

نوع پارامتر

توضیحات

userName

string

نام کاربری جهت اهراز هویت

password

string

مکملی برای نام کاربری برای اهراز هویت

code

string

کد محصول برای فیلتر شدن

groupName

string

گروه محصول

مقدار بازگشتی

نام پارامتر

نوع پارامتر

توضیحات

ProductInfoResult

object

نوع خروجی این متد object ای از نوع productInfoResult می باشد که دارای خصوصیات زیر می باشد:

1-      Success: موفقیت یا عدم موفقیت فیلترشدن را مشخص می کند

2-      Message: در صورت عدم موفقیت دارای مقدار می باشد که دلیل عدم موفقیت را حمل می کند

3-      CrmId: استفاده نشده

4-      ProductInfoList: لیست محصولاتی که فیلتر شده اند را حمل میکند

پارامترهای ورودی

نام پارامتر

نوع پارامتر

توضیحات

userName

string

نام کاربری جهت اهراز هویت

Password

string

مکمل نام کاربری جهت اهراز هویت

productId

guid

کد شناسایی محصول که برای هر محصول یکتا می باشد

پارامترهای ورودی

نام پارامتر

نوع پارامتر

توضیحات

userName

string

نام کاربری جهت اهراز هویت

password

string

مکملی برای نام کاربری برای اهراز هویت

serial

string

سریال کالا

پارامترهای ورودی

نام پارامتر

نوع پارامتر

توضیحات

userName

string

نام کاربری جهت اهراز هویت

password

string

مکملی برای نام کاربری برای اهراز هویت

name

string

نام محصول برای فیلتر شدن

groupName

string

گروه محصول

پارامترهای ورودی

نام پارامتر

نوع پارامتر

توضیحات

userName

string

نام کاربری جهت اهراز هویت

password

string

مکملی برای نام کاربری برای اهراز هویت

productCode

string

کد محصول برای فیلتر شدن

serialNumber

string

شماره سریال قلم محصول

مقدار بازگشتی

نام پارامتر

نوع پارامتر

توضیحات

ProductItemInfo

object

نوع خروجی این متد یک object از نوع ProductItemInfo است که دارای دو ویژگی Message و Success می باشد.

·         ویژگی Message پیغامی مبنی بر موفقیت عملیات را به همراه شرح خطا باز می‌گرداند.

·         ویژگی Success مقداری از نوع bool مبنی بر موفقیت یا عدم موفقیت نهایی در عملکرد وب سرویس را باز می‌گرداند.

فیلدهای کلاس ProductItemInfo

نام

نوع

توضیحات

ProductName

string

نام انبار را مشخص می کند

ProductId

Guid

شناسه محصول را  مشخص می کند.

InventoryId

Guid?

شناسه انبار را مشخص می کند.

InventoryName

string

نام انبار را مشخص می کند.

ProductItemInventoryStatus

ProductItemInventoryStatus

وضعیت این قلم کالا در انبار را مشخص می کند.

ProductItemStatus

ProductItemStatus

وضعیت سلامت این قلم کالا را مشخص می کند.

ProductionDate

DateTime?

تاریخ تولید را مشخص می کند

ExpireDate

DateTime?

تاریخ انقضا را مشخص میکند.

WarrantyStartType

WarrantyStartType

نحوه شروع تاریخ گارانتی را مشخص می کند.

WarrantyDurationMonths

int?

مدت گارانتی به ماه را مشخص می کند.

WarrantyStartDate

DateTime?

تاریخ شروع گارانتی را مشخص می کند.

WarrantyEndDate

DateTime?

تاریخ خاتمه گارانتی را مشخص می کند.

InputTransactionId

Guid?

رسید انبار مرتبط را مشخص می کند.

OutputTransactionId

Guid?

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

HistoryItems

List<ProductItemHistory>

سوابق این قلم کالا را مشخص می کند.

فیلدهای کلاس ProductItemHistory

نام

نوع

توضیحات

Number

string

شماره تراکنش انبار را مشخص می کند

SerialNumber

string

شماره سریال را  مشخص می کند.

DateTime

DateTime

تاریخ تراکنش انبار را مشخص می کند.

ShipperDesc

string

نام تحویل دهنده را مشخص می کند.

ShipperIdentityId

Guid?

شناسه هویت تحویل دهنده را مشخص می کند.

ShipperUserId

Guid?

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

ReceiverDesc

string

نام تحویل گیرنده را مشخص می کند.

ReceiverIdentityId

Guid?

شناسه هویت تحویل گیرنده را مشخص می کند.

ReceiverUserId

Guid?

شناسه کاربر تحویل گیرنده را مشخص می کند.

SourceInventoryName

string

انبار مبدا را مشخص می کند.

SourceInventoryId

Guid?

شناسه انبار مبدا را مشخص می کند.

DestinationInventoryName

string

انبار مقصد را مشخص می کند.

DestinationInventoryId

Guid?

شناسه انبار مقصد را مشخص می کند.

InventoryTransactionType

InventoryTransactionType

نوع تراکنش انبار را مشخص می کند.

TransactionStatus

TransactionStatus

وضعیت تراکنش انبار را مشخص می کند.

پارامترهای ورودی

نام پارامتر

نوع پارامتر

توضیحات

userName

string

این پارامتر نام کاربری کاربر مورد نظر را جهت بررسی دریافت می نماید.

password

string

این پارامتر رمز عبور کاربر مورد نظر را جهت بررسی دریافت می نماید.

productGroupInfo

ProductGroupInfo

این پارامتر که از نوع کلاس productGroupInfo می باشد تمامی اطلاعات مربوط به گروه محصول مورد نظر را برای ثبت در پایگاه داده دریافت می نماید.

فیلدهای کلاس ProductGroupInfo

نام

نوع

توضیحات

Id

Guid?

شناسه مربوط به گروه محصول برای ویرایش کردن محصول استفاده میشود.

Name

RefId

string

string

نام گروه محصول در این پارامتر مشخص می گردد.

میتوانید مقدار شناسه این محصول در سیستم دیگر را وارد کنید

ParentGroupId

Guid?

شناسه مربوط به والد گروه محصول در این پارامتر مشخص می گردد.

Code

string

کد گروه محصول در این پارامتر مشخص می گردد.

مقدار بازگشتی

نام پارامتر

نوع پارامتر

توضیحات

SaveProductGroupResult

object

نوع خروجی این متد یک object از نوع SaveProductGroupResult است که دارای دو ویژگی Message و  ProductGroupId وSuccess می باشد.

·         ویژگی Message پیغامی مبنی بر عدم موفقیت ذخیره اطلاعات را به همراه شرح خطا باز می‌گرداند.

·         ویژگی Success مقداری از نوع bool مبنی بر موفقیت یا عدم موفقیت نهایی در عملکرد وب سرویس را باز می‌گرداند.

·         ویژگی ProductGroupId مقداری از نوع Guid را در صورت ذخیره گروه محصول برمیگرداند که شناسه یکتا گروه محصول است.

پارامترهای ورودی

نام پارامتر

نوع پارامتر

توضیحات

userName

string

این پارامتر نام کاربری کاربر مورد نظر را جهت بررسی دریافت می نماید.

password

string

این پارامتر رمز عبور کاربر مورد نظر را جهت بررسی دریافت می نماید.

groupId

Guid

این پارامتر شناسه یکتا گروه محصول را دریافت میکند.

مقدار بازگشتی

نام پارامتر

نوع پارامتر

توضیحات

ProductGroupResult

object

نوع خروجی این متد یک object از نوع ProductGroupResult است که دارای دو ویژگی Message و  ProductGroupInfo وSuccess می باشد.

·         ویژگی Message پیغامی مبنی بر عدم موفقیت ذخیره اطلاعات را به همراه شرح خطا باز می‌گرداند.

·         ویژگی Success مقداری از نوع bool مبنی بر موفقیت یا عدم موفقیت نهایی در عملکرد وب سرویس را باز می‌گرداند.

·         ویژگی ProductGroupInfo طبق جدول ورودی در زمان ذخیره گروه محصول تمام پارامتر ها را خروجی میدهد.

فیلدهای کلاس ProductGroupInfo

نام

نوع

توضیحات

Id

Guid?

شناسه مربوط به گروه محصول برای ویرایش کردن محصول استفاده میشود.

Name

string

نام گروه محصول در این پارامتر مشخص می گردد.

ParentGroupId

Guid?

شناسه مربوط به والد گروه محصول در این پارامتر مشخص می گردد.

Code

string

کد گروه محصول در این پارامتر مشخص می گردد.