Invoice

بروزرسانی فاکتور

put/v2/invoice/{code}

Request

  • Base URL: https://api.payping.ir
  • URL: https://api.payping.ir/v2/invoice/{code}
  • 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:write)

Path parameters

codestring required

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

Request body

codestring required

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

createStatus0 | 1 | 2

نوع ثبت: 0 = ذخیره در پیش نویس 1 = ارسال 2 = دستی پرداخت شد

paidManualDescriptionstring

شرح پرداخت دستی

saveToTemplateboolean

ذخیره به عنوان قالب

templateCodestring

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

invoiceNumberinteger

شماره فاکتور

invoiceTitlestring

عنوان فاکتور

invoiceDateTimestring date-time

تاریخ ثبت

dueDatestring date-time

تاریخ سررسید- تاریخی که باید پرداخت صورت پذیرد

totalDiscountValuenumber double

تخفیف به کل فاکتور

totalDiscountType0 | 1

نوع تخفیف به مبلغ یا درصد 1 = مبلغ 0 = درصد

shippingnumber double

هزینه حمل و نقل

notesstring

متن جهت ارسال به دریافت کننده

termsAndConditionsstring

متن شرایط و قوانین جهت ارسال به دریافت کننده

memostring

ایجاد یک متن دلخواه جهت یادآوری فقط برای کاربر ثبت کننده

isSendAttachmentsAfterPaymentboolean

نمایش فایل های ضمیمه به پرداخت کننده پس از پرداخت موفق = true, نمایش در قبل و بعد از پرداخت = false

isSendNotesAndTermsAfterPaymentboolean

نمایش پیام به پرداخت کننده پس از پرداخت موفق = true, نمایش در قبل و بعد از پرداخت = false

isSendTermsAfterPaymentboolean

نمایش متن قوانین و مقررات به پرداخت کننده پس از پرداخت موفق = true, نمایش در قبل و بعد از پرداخت = false

attachmentsIdsstring[]

کلید(های) یکتا دریافت شده از سرویس آپلود به صورت آرایه از رشته ها قرار دهید

isDevicePaymentboolean

ثبت فاکتور بدون مشتری = true, با مشتری = false

Response

نمایش فاکتور

codestring

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

parentCodestring

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

paymentCodestring

کد یکتای پرداخت

status0 | 1 | 2 | 3 | 4 | 5

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

paidManualDescriptionstring

شرح پرداخت دستی

saveToTemplateboolean

ذخیره به عنوان قالب فاکتور

invoiceNumberinteger

شماره فاکتور

invoiceTitlestring

عنوان فاکتور

invoiceDateTimestring date-time

تاریخ ثبت

dueDatestring date-time

تاریخ سررسید

payedDateTimestring date-time

تاریخ پرداخت

canceledDateTimestring date-time

تاریخ لغو

subTotalnumber double

جمع مبلغ پرداختی آیتم های مالی

itemsDiscountAmountnumber double

جمع مبلغ تخفیف آیتم های مالی

totalDiscountAmountnumber double

مبلغ تخفیف به کل فاکتور

totalDiscountPercentinteger

درصد تخفیف به کل فاکتور

totalDiscountType0 | 1

نوع تخفیف به کل فاکتور: 1 = مبلغ 0 = درصد

sumDiscountAmountnumber double

جمع کل تخفیف اعمال شده روی فاکتور

totalTaxtionAmountnumber double

مبلغ مالیات

shippingnumber double

هزینه حمل و نقل

totalnumber double

مبلغ کل

notesstring

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

termsAndConditionsstring

متن شرایط و قوانین جهت نمایش به پرداخت کننده

memostring

متن دلخواه جهت یادآوری فقط برای صادر کننده فاکتور

isSendAttachmentsAfterPaymentboolean

نمایش فایل های ضمیمه به پرداخت کننده پس از پرداخت موفق = true, نمایش در قبل و بعد از پرداخت = false

isSendNotesAndTermsAfterPaymentboolean

نمایش پیام به پرداخت کننده پس از پرداخت موفق = true, نمایش در قبل و بعد از پرداخت = false

isSendTermsAfterPaymentboolean

نمایش متن قوانین و مقررات به پرداخت کننده پس از پرداخت موفق = true, نمایش در قبل و بعد از پرداخت = false

attachFileIdsstring[]

لیست کلید یکتای فایل های ضمیمه

attachFileAddressesstring[]

لیست آدرس فایل های ضمیمه

qrCodeFileNamestring

آدرس تصویر بارکد فاکتور

Example response

{
  "billToes": [
    {
      "addressBook": {
        "email": "info@example.com",
        "phone": "09110000000",
        "firstName": "پوریا",
        "lastName": "منفرد",
        "businessName": "پی‌پینگ",
        "additionalInfo": "او یک وکیل است",
        "memo": "در پی‌پینگ با ایشان آشنا شدم",
        "zipCode": "46169696164",
        "state": "تهران",
        "city": "تهران",
        "location": "خیابان جمهوری",
        "nationalId": "22266655591"
      }
    }
  ]
}

Changes

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