ایجاد پیشفاکتور
این Endpoint برای ایجاد یک پیشفاکتور جدید در دیدار استفاده میشود. هر پیشفاکتور میتواند شامل یک یا چند ردیف محصول باشد و در صورت نیاز اطلاعات خریدار، اطلاعات فروشنده، تاریخ صدور، مدت اعتبار، تخفیف، مالیات، توضیحات و معامله مرتبط هم همراه آن ثبت شود. در این ساختار،SellerInfo مربوط به کسبوکاری است که از دیدار استفاده میکند و پیشفاکتور را به نام خودش صادر میکند. BuyerInfo اطلاعات شخص یا شرکتی را نگه میدارد که پیشفاکتور برای او صادر میشود.
پارامترهای Query
Header درخواست
بدنه درخواست
array
required
فهرست ردیفهای محصول پیشفاکتور است. هر عضو این آرایه یک ردیف مستقل از پیشفاکتور را میسازد و مشخص میکند چه محصولی، با چه تعداد، چه قیمت واحدی و چه اطلاعات تکمیلی روی سند ثبت شود.
object
این آبجکت در نمونه درخواست بهصورت خالی (
{}) ارسال شده است. جزو حداقل درخواست نیست و جزئیات داخلی یا کاربرد دقیق آن در اطلاعات ارائهشده مشخص نشده است.object
اطلاعات فروشندهای است که پیشفاکتور به نام او صادر میشود. منظور از فروشنده در اینجا همان کسبوکار یا شرکتی است که از دیدار استفاده میکند، نه یک شرکتِ مشتری که بهعنوان Contact داخل CRM ثبت شده است.
object
اطلاعات خریدار پیشفاکتور است. خریدار میتواند یک
Person یا یک Company باشد و اطلاعات این آبجکت را میتوانید براساس اطلاعات همان شخص یا شرکت در دیدار پر کنید.string
required
شناسه Userی است که بهعنوان ایجادکننده پیشفاکتور ثبت میشود.
string
تاریخ و زمان صدور پیشفاکتور است.
number | string
مبلغ تعدیل نهایی پیشفاکتور است که همراه جمع محاسبات سند ارسال میشود. در نمونه کامل مقدار منفی برای این فیلد استفاده شده است.
array
فهرست ردیفهای تخفیف پیشفاکتور است. در نمونه کامل ارائهشده این آرایه خالی است و ساختار اعضای آن در اطلاعات ورودی مشخص نشده است.
string
required
شناسه بیزدامنه است.
number
required
شناسه ارزی است که مبالغ این پیشفاکتور براساس آن ثبت میشوند.
string
شناسه معاملهای است که میخواهید پیشفاکتور به آن متصل شود. اگر این فیلد ارسال شود، پیشفاکتور به همان معامله در دیدار مرتبط میشود.
number
تعداد روزهایی است که پیشفاکتور از زمان صدور معتبر در نظر گرفته میشود.
string
توضیحات کلی پیشفاکتور است و برای متنی استفاده میشود که مربوط به کل سند است، نه فقط یک ردیف محصول.
قواعد و محدودیتها
- حداقل بدنه لازم برای ایجاد پیشفاکتور شامل
Items،CreatorId،BizDomainIdوCurrencyIdاست. - داخل هر عضو
Items، فیلدهایTitle،Description،Unit،UnitPrice،ProductId،ProductCodeوQuantityالزامی هستند. - اگر محصول متغیر باشد،
VariantIdهمان Variant انتخابشده را هم ارسال کنید. برای محصول بدون Variant نیازی بهVariantIdنیست. - مقدار
Items[].UnitPriceهمان قیمت واحدی است که برای آن ردیف محصول روی پیشفاکتور نمایش داده میشود. BuyerInfo.BuyerTypeفقط یکی از دو مقدارPersonیاCompanyرا میپذیرد.BuyerEconomicCode،BuyerNationalCodeوBuyerRegistrationNumberفقط برای خریدار از نوعCompanyارسال میشوند.
حداقل درخواست
VariantId را هم داخل همان عضو Items اضافه کنید.