پرش به مطلب اصلی

دریافت صورت‌حساب اشخاص

پاتریس یار صورت‌حساب اشخاص مای پاتریس را با POST /patris-yar/mypatris/statements به سایت می‌فرستد. صورت‌حساب هر شخص همیشه کامل ارسال می‌شود و سایت باید همه‌ی ردیف‌های قبلی آن شخص را با ردیف‌های جدید جایگزین کند.

پیش‌نیازها​

Endpoint​

POST /patris-yar/mypatris/statements

هدرها​

نامنوعالزامیتوضیح
X-Payava-Keystringبلهکلید API حساب پاتریس.
Content-Typestringبلهapplication/json; charset=utf-8

پارامترها​

نامنوعالزامیتوضیح
statementsarrayبلهصورت‌حساب‌ها، یکی برای هر شخص.
statements[].person_codeintegerبلهکد حساب شخص؛ همان code در اشخاص.
statements[].linesarrayبلههمه‌ی ردیف‌های صورت‌حساب به ترتیب نمایش. آرایه‌ی خالی یعنی صورت‌حساب خالی.

فیلدهای هر ردیف​

نامنوعالزامیتوضیح
wraz_idintegerخیرشناسه‌ی ردیف در پاتریس.
doc_numberintegerخیرشماره‌ی سند.
doc_datestringخیرتاریخ سند.
descstringخیرشرح ردیف.
quantitynumberخیرتعداد.
debtornumberبلهمبلغ بدهکار، به واحد پاتریس.
creditornumberبلهمبلغ بستانکار، به واحد پاتریس.

نمونه درخواست و پیاده‌سازی​

ارسال صورت‌حساب
curl -X POST https://shop.example.com/patris-yar/mypatris/statements \
-H "X-Payava-Key: YOUR_API_KEY" \
-H "Content-Type: application/json; charset=utf-8" \
-d '{"statements":[{"person_code":101001,"lines":[{"wraz_id":2189510,"doc_number":120,"doc_date":"1405/08/04","desc":"فاکتور فروش 10","quantity":12,"debtor":1200000,"creditor":0}]}]}'

نمونه پاسخ موفق​

200 OK
{ "persons": 1, "lines": 1 }

پاتریس یار مقدارهای پاسخ را نمی‌خواند. فقط موفق بودن پاسخ مهم است.

کدهای خطا​

نامنوعالزامیتوضیح
401payava_patris_unauthorized—کلید نادرست است.
400invalid_json—بدنه‌ی درخواست JSON معتبر نیست.

نکته‌ها​

جایگزینی در یک تراکنش

حذف ردیف‌های قبلی و درج ردیف‌های جدید هر شخص را در یک تراکنش پایگاه داده انجام دهید. در غیر این صورت مشتری ممکن است در همان لحظه صورت‌حساب خالی یا نیمه‌کاره ببیند.

  • ترتیب lines همان ترتیب نمایش است. ترتیب را با یک ستون شماره‌ی ردیف ذخیره کنید.
  • ردیف‌های شخصی که در این درخواست نیامده، دست نخورده می‌مانند.