Invoice

لیست فاکتور ها

get/v2/invoice/List

Request

  • Base URL: https://api.payping.ir
  • URL: https://api.payping.ir/v2/invoice/List
  • Auth: one of:
    • API key in header Authorization
    • OAuth 2 (authorization code, authorization URL https://oauth.payping.ir/connect/authorize, token URL https://oauth.payping.ir/connect/token, scopes: invoice:read)

Query parameters

offsetinteger
limitinteger
status0 | 1 | 2 | 3 | 4 | 5 | 6 | 7

فیلتر وضعیت فاکتور:

  • 0 - پیش‌نویس
  • 1 - در انتظار پرداخت
  • 2 - پرداخت شد
  • 3 - معوق
  • 4 - لغو شده
  • 5 - همه
  • 6 - مرجوعی
  • 7 - اصلاحیه
isArchivedboolean

فیلتر بایگانی

IsSearchDueDateboolean

فیلتر با تاریخ سررسید

IsSearchCreateDateboolean

فیلتر با تاریخ ثبت

searchDateFromstring date-time

شروع از تاریخ

searchDateTostring date-time

تا تاریخ

searchstring

متن جستجو:

  • جستجو بر روی نام فاکتور
  • جستجو بر روی کد مشتری
  • جست و جو بر روی شماره فاکتور
  • جست و جو بر روی تاریخ فارسی ارسال و سر رسید
  • جست و جو بر روی مبلغ نهایی فاکتور
  • جست و جو بر روی کد فاکتور والد
CustomerCodestring

فیلتر بر اساس کد مشتری

invoiceCodestring

فیلتر براساس کد فاکتور

Response

نمایش لیست فاکتور ها

codestring

کلید یکتای فاکتور

numberinteger

شماره فاکتور

sendDatestring date-time

تاریخ ثبت فاکتور

dueDatestring date-time

تاریخ سررسید فاکتور

payedDateTimestring date-time nullable

تاریخ پرداخت

canceledDateTimestring date-time nullable

تاریخ لغو

titlestring

عنوان

status0 | 1 | 2 | 3 | 4 | 5

وضعیت فاکتور: 0 = پیش‌نویس 1 = در انتظار پرداخت 2 = پرداخت شد 3 = معوق 4 = لغو شده 5 = همه

invoicePaidBystring nullable

پرداخت‌کننده فاکتور

totalnumber double

مبلغ نهایی یا قابل پرداخت

isCorrectionboolean

آیا این فاکتور اصلاحیه است

isScheduleboolean

آیا این فاکتور زمان‌بندی شده است

customerCodestring

کد مشتری

Changes

No recorded changes to this operation across all 1 revision of this API.