Skip to main content

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

این Endpoint برای دریافت اطلاعات یک فاکتور یا پیش‌فاکتور مشخص استفاده می‌شود. برای پیدا کردن سند می‌توانید یکی از شناسه، شماره سند یا شماره فرمت‌شده آن را ارسال کنید. در هر درخواست باید فقط و فقط یکی از فیلدهای Id، InvoiceFormattedNumber، InvoiceNumber، QuoteFormattedNumber یا QuoteNumber ارسال شود. ارسال همزمان دو یا چند مورد باعث خطا می‌شود.

پارامترهای Query

Header درخواست

بدنه درخواست

بدنه درخواست باید دقیقاً یکی از فیلدهای زیر را داشته باشد.
number
شناسه فاکتور یا پیش‌فاکتوری است که می‌خواهید دریافت کنید. همین فیلد برای شناسه هر دو نوع سند، یعنی فاکتور و پیش‌فاکتور، استفاده می‌شود.
string
شماره فرمت‌شده فاکتور است؛ برای مثال I-23.
string
شماره فاکتور است؛ برای مثال 23.0.
string
شماره فرمت‌شده پیش‌فاکتور است؛ برای مثال Q-21.
string
شماره پیش‌فاکتور است؛ برای مثال 21.0.

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

  • بدنه درخواست باید دقیقاً یک فیلد از بین Id، InvoiceFormattedNumber، InvoiceNumber، QuoteFormattedNumber و QuoteNumber داشته باشد.
  • ارسال دو یا چند فیلد از این مجموعه در یک درخواست معتبر نیست و Endpoint خطا برمی‌گرداند.
  • فیلد Id هم برای شناسه فاکتور و هم برای شناسه پیش‌فاکتور استفاده می‌شود؛ فیلد جداگانه‌ای مثل InvoiceId یا QuoteId در این درخواست ارسال نمی‌شود.
  • برای دریافت فاکتور با شماره فرمت‌شده از InvoiceFormattedNumber و برای دریافت پیش‌فاکتور با شماره فرمت‌شده از QuoteFormattedNumber استفاده کنید.
  • برای دریافت فاکتور با شماره سند از InvoiceNumber و برای دریافت پیش‌فاکتور با شماره سند از QuoteNumber استفاده کنید.

نمونه درخواست‌های معتبر

با شناسه فاکتور یا پیش‌فاکتور:
با شماره فرمت‌شده فاکتور:
با شماره فاکتور:
با شماره فرمت‌شده پیش‌فاکتور:
با شماره پیش‌فاکتور:

نمونه درخواست نامعتبر

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

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