Skip to main content

ویرایش پیش‌فاکتور

این Endpoint برای ویرایش یک پیش‌فاکتور موجود در دیدار استفاده می‌شود. ساختار بدنه آن با ویرایش فاکتور یکسان است؛ با این تفاوت که درخواست به Endpoint مخصوص پیش‌فاکتور ارسال می‌شود. علاوه بر فیلدهای لازم برای ثبت اطلاعات سند، باید Id پیش‌فاکتوری را که می‌خواهید ویرایش کنید هم در بدنه درخواست ارسال کنید. در این ساختار، SellerInfo مربوط به کسب‌وکاری است که از دیدار استفاده می‌کند و پیش‌فاکتور را به نام خودش صادر می‌کند. BuyerInfo اطلاعات شخص یا شرکتی را نگه می‌دارد که این پیش‌فاکتور برای او صادر شده است.

پارامترهای Query

Header درخواست

بدنه درخواست

number
required
شناسه پیش‌فاکتوری است که می‌خواهید ویرایش کنید. این مقدار باید Id همان پیش‌فاکتور موجود در دیدار باشد.
array
required
فهرست ردیف‌های محصول پیش‌فاکتور است. هر عضو این آرایه یک ردیف مستقل از پیش‌فاکتور را مشخص می‌کند و تعیین می‌کند چه محصولی، با چه تعداد، چه قیمت واحدی و چه اطلاعات تکمیلی بعد از ویرایش روی پیش‌فاکتور ثبت شود.
object
این آبجکت در نمونه درخواست به‌صورت خالی ({}) ارسال شده است. جزو حداقل درخواست نیست.
object
اطلاعات فروشنده‌ای است که پیش‌فاکتور به نام او صادر می‌شود. منظور از فروشنده در اینجا همان کسب‌وکار یا شرکتی است که از دیدار استفاده می‌کند، نه یک شرکتِ مشتری که به‌عنوان Contact داخل CRM ثبت شده است.
object
اطلاعات خریدار پیش‌فاکتور است. خریدار می‌تواند یک Person یا یک Company باشد و اطلاعات این آبجکت را می‌توانید براساس اطلاعات همان شخص یا شرکت در دیدار پر کنید.
object
اطلاعات تکمیلی ایجادکننده پیش‌فاکتور است. در نمونه درخواست به‌صورت آبجکت خالی ({}) ارسال شده و جزو حداقل درخواست نیست.
string
required
شناسه Userی است که به‌عنوان ایجادکننده پیش‌فاکتور ثبت می‌شود.
string
تاریخ و زمان صدور پیش‌فاکتور است.
number | string
مبلغ تعدیل نهایی پیش‌فاکتور است که همراه جمع محاسبات سند ارسال می‌شود.
array
فهرست ردیف‌های تخفیف پیش‌فاکتور است. در نمونه ارائه‌شده این آرایه خالی است و ساختار اعضای آن مشخص نشده است.
string
required
شناسه بیزدامنه است.
number
required
شناسه ارزی است که مبالغ این پیش‌فاکتور براساس آن ثبت می‌شوند.
string
شناسه معامله‌ای است که پیش‌فاکتور به آن متصل است یا می‌خواهید بعد از ویرایش به آن متصل باشد.
string
توضیحات کلی پیش‌فاکتور است و برای متنی استفاده می‌شود که مربوط به کل سند است، نه فقط یک ردیف محصول.

قواعد و محدودیت‌ها

  • حداقل بدنه لازم برای ویرایش پیش‌فاکتور شامل Id، Items، CreatorId، BizDomainId و CurrencyId است.
  • Id باید شناسه همان پیش‌فاکتوری باشد که قصد ویرایش آن را دارید.
  • داخل هر عضو Items، فیلدهای Title، Description، Unit، UnitPrice، ProductId، ProductCode و Quantity الزامی هستند.
  • اگر محصول متغیر باشد، VariantId همان Variant انتخاب‌شده را هم ارسال کنید. برای محصول بدون Variant نیازی به VariantId نیست.
  • مقدار Items[].UnitPrice همان قیمت واحدی است که برای آن ردیف محصول روی پیش‌فاکتور نمایش داده می‌شود.
  • BuyerInfo.BuyerType فقط یکی از دو مقدار Person یا Company را می‌پذیرد.
  • BuyerEconomicCode، BuyerNationalCode و BuyerRegistrationNumber فقط برای خریدار از نوع Company ارسال می‌شوند.

حداقل درخواست

اگر محصول متغیر است، VariantId را هم داخل همان عضو Items اضافه کنید.

لینک‌های مرتبط