دریافت صورتحساب اشخاص
پاتریس یار صورتحساب اشخاص مای پاتریس را با POST /patris-yar/mypatris/statements به سایت میفرستد. صورتحساب هر شخص همیشه کامل ارسال میشود و سایت باید همهی ردیفهای قبلی آن شخص را با ردیفهای جدید جایگزین کند.
پیشنیازها
Endpoint
POST /patris-yar/mypatris/statements
هدرها
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
X-Payava-Key | string | بله | کلید API حساب پاتریس. |
Content-Type | string | بله | application/json; charset=utf-8 |
پارامترها
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
statements | array | بله | صورتحسابها، یکی برای هر شخص. |
statements[].person_code | integer | بله | کد حساب شخص؛ همان code در اشخاص. |
statements[].lines | array | بله | همهی ردیفهای صورتحساب به ترتیب نمایش. آرایهی خالی یعنی صورتحساب خالی. |
فیلدهای هر ردیف
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
wraz_id | integer | خیر | شناسهی ردیف در پاتریس. |
doc_number | integer | خیر | شمارهی سند. |
doc_date | string | خیر | تاریخ سند. |
desc | string | خیر | شرح ردیف. |
quantity | number | خیر | تعداد. |
debtor | number | بله | مبلغ بدهکار، به واحد پاتریس. |
creditor | number | بله | مبلغ بستانکار، به واحد پاتریس. |
نمونه درخواست و پیادهسازی
- curl
- C#
- Python
- PHP
- Node.js
- Go
ارسال صورتحساب
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}]}]}'
POST /mypatris/statements
patris.MapPost("/mypatris/statements", async (StatementsRequest body, IMyPatrisStore store) =>
{
int persons = 0, lines = 0;
foreach (var s in body.Statements.Where(s => s.PersonCode != 0))
{
lines += await store.ReplaceStatementAsync(s.PersonCode, s.Lines); // delete + insert in one transaction
persons++;
}
return Results.Json(new { persons, lines });
});
public sealed class StatementsRequest
{
public List<MyPatrisStatement> Statements { get; set; } = new();
}
public sealed class MyPatrisStatement
{
[System.Text.Json.Serialization.JsonPropertyName("person_code")] public long PersonCode { get; set; }
public List<MyPatrisStatementLine> Lines { get; set; } = new();
}
public sealed class MyPatrisStatementLine
{
[System.Text.Json.Serialization.JsonPropertyName("wraz_id")] public long WrazId { get; set; }
[System.Text.Json.Serialization.JsonPropertyName("doc_number")] public int DocNumber { get; set; }
[System.Text.Json.Serialization.JsonPropertyName("doc_date")] public string? DocDate { get; set; }
public string? Desc { get; set; }
public double Quantity { get; set; }
public decimal Debtor { get; set; }
public decimal Creditor { get; set; }
}
POST /mypatris/statements
class StatementLine(BaseModel):
wraz_id: int = 0
doc_number: int = 0
doc_date: str = ""
desc: str = ""
quantity: float = 0
debtor: Decimal = Decimal(0)
creditor: Decimal = Decimal(0)
class Statement(BaseModel):
person_code: int
lines: list[StatementLine] = []
class StatementsRequest(BaseModel):
statements: list[Statement] = []
@router.post("/mypatris/statements")
def mypatris_statements(body: StatementsRequest):
persons = lines = 0
for s in body.statements:
if s.person_code == 0:
continue
lines += mypatris_store.replace_statement(s.person_code, s.lines) # delete + insert in one transaction
persons += 1
return {"persons": persons, "lines": lines}
POST /mypatris/statements
if ($method === 'POST' && $route === '/mypatris/statements') {
$persons = 0;
$lines = 0;
foreach ((array) (json_body()['statements'] ?? []) as $statement) {
$code = (int) ($statement['person_code'] ?? 0);
if ($code === 0) {
continue;
}
$lines += $myPatris->replaceStatement($code, (array) ($statement['lines'] ?? [])); // delete + insert in one transaction
$persons++;
}
respond(200, ['persons' => $persons, 'lines' => $lines]);
}
POST /mypatris/statements
router.post('/mypatris/statements', async (req, res, next) => {
try {
let persons = 0;
let lines = 0;
for (const s of req.body.statements || []) {
const code = Number(s.person_code) || 0;
if (code === 0) continue;
lines += await myPatrisStore.replaceStatement(code, s.lines || []); // delete + insert in one transaction
persons++;
}
res.json({ persons, lines });
} catch (err) {
next(err);
}
});
POST /mypatris/statements
type StatementLine struct {
WrazID int64 `json:"wraz_id"`
DocNumber int `json:"doc_number"`
DocDate string `json:"doc_date"`
Desc string `json:"desc"`
Quantity float64 `json:"quantity"`
Debtor float64 `json:"debtor"`
Creditor float64 `json:"creditor"`
}
func myPatrisStatements(w http.ResponseWriter, r *http.Request) {
var body struct {
Statements []struct {
PersonCode int64 `json:"person_code"`
Lines []StatementLine `json:"lines"`
} `json:"statements"`
}
if err := json.NewDecoder(r.Body).Decode(&body); err != nil {
writeJSON(w, http.StatusBadRequest, map[string]string{"code": "invalid_json", "message": err.Error()})
return
}
persons, lines := 0, 0
for _, s := range body.Statements {
if s.PersonCode == 0 {
continue
}
lines += myPatrisStore.ReplaceStatement(r.Context(), s.PersonCode, s.Lines) // delete + insert in one transaction
persons++
}
writeJSON(w, http.StatusOK, map[string]int{"persons": persons, "lines": lines})
}
// patris.HandleFunc("POST "+base+"/mypatris/statements", myPatrisStatements)
نمونه پاسخ موفق
200 OK
{ "persons": 1, "lines": 1 }
پاتریس یار مقدارهای پاسخ را نمیخواند. فقط موفق بودن پاسخ مهم است.
کدهای خطا
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
401 | payava_patris_unauthorized | — | کلید نادرست است. |
400 | invalid_json | — | بدنهی درخواست JSON معتبر نیست. |
نکتهها
جایگزینی در یک تراکنش
حذف ردیفهای قبلی و درج ردیفهای جدید هر شخص را در یک تراکنش پایگاه داده انجام دهید. در غیر این صورت مشتری ممکن است در همان لحظه صورتحساب خالی یا نیمهکاره ببیند.
- ترتیب
linesهمان ترتیب نمایش است. ترتیب را با یک ستون شمارهی ردیف ذخیره کنید. - ردیفهای شخصی که در این درخواست نیامده، دست نخورده میمانند.