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

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

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

پیش‌نیازها​

Endpoint​

POST /wp-json/payava-patris/v1/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بلهمبلغ بستانکار، به واحد پاتریس.

پیاده‌سازی در وردپرس​

POST /mypatris/statements
function my_patris_mypatris_statements(WP_REST_Request $request)
{
global $wpdb;
$table = $wpdb->prefix . 'my_patris_bills'; // person_code, sort, wraz_id, doc_number, doc_date, description, quantity, debtor, creditor
$persons = $lines = 0;
foreach ((array) $request->get_param('statements') as $statement) {
$code = (int) ($statement['person_code'] ?? 0);
if ($code === 0) {
continue;
}
$wpdb->query('START TRANSACTION');
$wpdb->delete($table, ['person_code' => $code]); // the whole statement is replaced
$sort = 0;
foreach ((array) ($statement['lines'] ?? []) as $line) {
$wpdb->insert($table, [
'person_code' => $code,
'sort' => $sort++,
'wraz_id' => (int) ($line['wraz_id'] ?? 0),
'doc_number' => (int) ($line['doc_number'] ?? 0),
'doc_date' => sanitize_text_field((string) ($line['doc_date'] ?? '')),
'description' => sanitize_text_field((string) ($line['desc'] ?? '')),
'quantity' => (float) ($line['quantity'] ?? 0),
'debtor' => (float) ($line['debtor'] ?? 0),
'creditor' => (float) ($line['creditor'] ?? 0),
]);
}
$wpdb->query('COMMIT');
$persons++;
$lines += $sort;
}
return ['persons' => $persons, 'lines' => $lines];
}

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

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

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

کدهای خطا​

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

نکته‌ها​

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

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

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