واجهة البرمجة المالية لـ SolaCount
تتيح واجهة SolaCount البرمجية للمحاسبة قراءة البيانات المحاسبية وكتابتها برمجياً — العملاء والموردون والفواتير وفواتير الموردين والمدفوعات وقيود اليومية والتقارير المالية. تعيد جميع نقاط الاتصال بيانات JSON. إنشاء مفتاح API ←
المصادقة
تتطلب كل نقطة نهاية محمية ثلاثة ترويسات:
X-API-Key: solabooks_<prefix>.<secret> X-Organization-Id: 1 X-Client-Id: 4
- X-API-Key — المفتاح الكامل الذي يظهر مرة واحدة عند الإنشاء في الإعدادات ← الوصول إلى API
- X-Organization-Id — المعرّف الرقمي لمؤسستك (يظهر في صفحة الوصول إلى API)
- X-Client-Id — معرّف العميل الخاص بك (يظهر في صفحة الوصول إلى API)
نقطة النهاية GET /api/v1/health لا تتطلب مصادقة، ويمكن استخدامها للتحقق من الاتصال.
تنسيق الاستجابة
تستخدم جميع الاستجابات غلافًا موحّدًا بصيغة JSON.
كائن واحد
{
"success": true,
"data": { ... }
}
قائمة مقسّمة إلى صفحات
{
"success": true,
"data": [ ... ],
"meta": {
"current_page": 1,
"per_page": 25,
"total": 100,
"last_page": 4
}
}
خطأ
{
"success": false,
"error": {
"code": "error_code",
"message": "Human readable message."
}
}
اختبار سريع
استبدل your_key و1 و4 بمفتاح API الفعلي ومعرّف المؤسسة ومعرّف العميل.
فحص الحالة (لا يتطلب مصادقة)
curl https://solacount.com/api/v1/health
عرض الفواتير
curl https://solacount.com/api/v1/invoices \ -H "X-API-Key: your_key" \ -H "X-Organization-Id: 1" \ -H "X-Client-Id: 4"
إنشاء عميل
curl -X POST https://solacount.com/api/v1/customers \
-H "X-API-Key: your_key" \
-H "X-Organization-Id: 1" \
-H "X-Client-Id: 4" \
-H "Content-Type: application/json" \
-d '{"name":"Demo Customer","email":"billing@example.com"}'
إنشاء قيد يومية
curl -X POST https://solacount.com/api/v1/journal-entries \
-H "X-API-Key: your_key" \
-H "X-Organization-Id: 1" \
-H "X-Client-Id: 4" \
-H "Content-Type: application/json" \
-d '{
"date": "2026-06-07",
"reference": "JE-001",
"description": "Manual accrual",
"lines": [
{"account_id": 101, "debit": 1000, "credit": 0},
{"account_id": 202, "debit": 0, "credit": 1000}
]
}'
جميع نقاط النهاية
انقر على أي نقطة نهاية لتوسيع تفاصيلها. المجموع 33 نقطة نهاية عبر 8 مجموعات موارد.
السلامة
/api/v1/health
بدون مصادقة
تأكد من أن واجهة برمجة التطبيقات متصلة وتستجيب. لا يلزم تسجيل دخول.
الاستجابة HTTP 200
{"success":true,"data":{"service":"finance-api","status":"ok","timestamp":"2026-06-07T12:00:00+00:00"}}
العملاء
/api/v1/customers
النطاق: customers.get
عرض جميع العملاء. يدعم البحث والترقيم.
معلمات الاستعلام
| المعامل | اكتب | الوصف | |
|---|---|---|---|
search |
string |
اختياري | تصفية بالاسم أو البريد الإلكتروني أو الهاتف (تطابق جزئي) |
page |
integer |
اختياري | رقم الصفحة، والافتراضي 1 |
per_page |
integer |
اختياري | النتائج في الصفحة الواحدة (الافتراضي: 25، الحد الأقصى: 100) |
الاستجابة HTTP 200
{"success":true,"data":[{"id":1,"name":"Demo Customer","email":"billing@example.com","phone":"+1-555-0100","is_active":true}],"meta":{"current_page":1,"per_page":25,"total":3,"last_page":1}}
/api/v1/customers/{id}
النطاق: customers.get
استرجع عميلاً واحداً بالمعرّف.
الاستجابة HTTP 200
{"success":true,"data":{"id":1,"name":"Demo Customer","email":"billing@example.com","phone":"+1-555-0100","is_active":true}}
/api/v1/customers
النطاق: customers.post
أنشئ عميلًا جديدًا.
نص الطلب (JSON)
| الميدان | اكتب | الوصف | |
|---|---|---|---|
name |
string |
مطلوب | اسم العميل |
email |
string |
اختياري | عنوان البريد الإلكتروني (يجب أن يكون بريدًا إلكترونيًا صالحًا) |
phone |
string |
اختياري | رقم الهاتف بحد أقصى 50 حرفًا |
is_active |
boolean |
اختياري | الحالة نشطة افتراضيًا |
الاستجابة HTTP 201
{"success":true,"data":{"id":42,"name":"Demo Customer","email":"billing@example.com","phone":null,"is_active":true}}
الموردون
/api/v1/suppliers
النطاق: suppliers.get
عرض جميع الموردين. يدعم البحث والترقيم.
معلمات الاستعلام
| المعامل | اكتب | الوصف | |
|---|---|---|---|
search |
string |
اختياري | تصفية بالاسم (تطابق جزئي) |
page |
integer |
اختياري | رقم الصفحة |
per_page |
integer |
اختياري | النتائج في الصفحة بحد أقصى 100 |
الاستجابة HTTP 200
{"success":true,"data":[{"id":1,"name":"Demo Supplier","email":"ap@example.com","tax_id":"GB123456789","is_vat_registered":true}],"meta":{"current_page":1,"per_page":25,"total":1,"last_page":1}}
/api/v1/suppliers/{id}
النطاق: suppliers.get
استرجع مورداً واحداً بالمعرّف.
الاستجابة HTTP 200
{"success":true,"data":{"id":1,"name":"Demo Supplier","email":"ap@example.com","phone":null,"tax_id":"GB123456789","is_overseas":false,"is_vat_registered":true,"reverse_charge":false}}
/api/v1/suppliers
النطاق: suppliers.post
أنشئ موردًا جديدًا.
نص الطلب (JSON)
| الميدان | اكتب | الوصف | |
|---|---|---|---|
name |
string |
مطلوب | اسم المورد |
email |
string |
اختياري | عنوان البريد الإلكتروني |
phone |
string |
اختياري | رقم الهاتف |
tax_id |
string |
اختياري | رقم تسجيل ضريبة القيمة المضافة / الضريبة |
is_overseas |
boolean |
اختياري | ما إذا كان المورّد من خارج البلاد (الافتراضي: false) |
is_vat_registered |
boolean |
اختياري | مسجَّل في ضريبة القيمة المضافة (الافتراضي: صحيح) |
reverse_charge |
boolean |
اختياري | تطبق ضريبة القيمة المضافة بالعكس (الافتراضي: false) |
الاستجابة HTTP 201
{"success":true,"data":{"id":15,"name":"Demo Supplier","email":"ap@example.com","tax_id":"GB123456789","is_vat_registered":true}}
الفواتير
/api/v1/invoices
النطاق: invoices.get
عرض جميع الفواتير مع علاقة العميل. يدعم فلترة الحالة والترقيم.
معلمات الاستعلام
| المعامل | اكتب | الوصف | |
|---|---|---|---|
status |
string |
اختياري | التصفية: draft | unpaid | paid | void | overdue
|
page |
integer |
اختياري | رقم الصفحة |
per_page |
integer |
اختياري | النتائج في الصفحة بحد أقصى 100 |
الاستجابة HTTP 200
{"success":true,"data":[{"id":101,"number":"INV-00101","date":"2026-06-01","due_date":"2026-07-01","status":"unpaid","total":5000.00,"customer":{"id":1,"name":"Demo Customer"}}],"meta":{"current_page":1,"per_page":25,"total":48,"last_page":2}}
/api/v1/invoices/{id}
النطاق: invoices.get
استرجع فاتورة واحدة مع العميل وبنود السطور.
الاستجابة HTTP 200
{"success":true,"data":{"id":101,"number":"INV-00101","date":"2026-06-01","due_date":"2026-07-01","status":"unpaid","subtotal":4347.83,"tax_total":652.17,"total":5000.00,"customer":{"id":1,"name":"Demo Customer"},"lines":[{"id":1,"description":"Consulting services","qty":10,"unit_price":434.78,"total":4347.83}]}}
/api/v1/invoices
النطاق: invoices.post
إنشاء فاتورة جديدة. تُنشأ بالحالة draft ورقم يُولَّد تلقائياً.
نص الطلب (JSON)
| الميدان | اكتب | الوصف | |
|---|---|---|---|
customer_id |
integer |
مطلوب | معرّف عميل موجود |
date |
date |
مطلوب | تاريخ الفاتورة (YYYY-MM-DD) |
due_date |
date |
اختياري | تاريخ استحقاق الدفع (YYYY-MM-DD) |
notes |
string |
اختياري | ملاحظات داخلية أو موجهة للعميل |
subtotal |
decimal |
اختياري | الإجمالي قبل الضريبة، والافتراضي صفر |
tax_total |
decimal |
اختياري | مبلغ الضريبة، والافتراضي صفر |
discount_total |
decimal |
اختياري | مبلغ الخصم، والافتراضي صفر |
total |
decimal |
اختياري | الإجمالي النهائي، والافتراضي صفر |
الاستجابة HTTP 201
{"success":true,"data":{"id":102,"number":"INV-00102","status":"draft","date":"2026-06-07","due_date":"2026-07-07","total":5000.00,"customer_id":1}}
/api/v1/invoices/{id}
النطاق: invoices.update
تحديث فاتورة مسودة موجودة. جميع الحقول اختيارية.
نص الطلب (JSON)
| الميدان | اكتب | الوصف | |
|---|---|---|---|
customer_id |
integer |
اختياري | معرّف العميل الجديد |
date |
date |
اختياري | تاريخ الفاتورة (YYYY-MM-DD) |
due_date |
date |
اختياري | تاريخ استحقاق الدفع |
notes |
string |
اختياري | ملاحظات |
subtotal |
decimal |
اختياري | الإجمالي قبل الضريبة |
tax_total |
decimal |
اختياري | مبلغ الضريبة |
total |
decimal |
اختياري | المجموع الكلي |
الاستجابة HTTP 200
{"success":true,"data":{"id":102,"status":"draft","total":6000.00,"customer":{"id":1,"name":"Demo Customer"},"lines":[]}}
/api/v1/invoices/{id}/post
النطاق: invoices.post
رحّل فاتورة مسودة إلى دفتر الأستاذ العام. يتطلب إجمالياً أكبر من 0 وتاريخاً. يغيّر الحالة إلى غير مدفوعة.
الاستجابة HTTP 200
{"success":true,"data":{"id":102,"status":"unpaid","posted_at":"2026-06-07T12:00:00Z","total":5000.00}}
الأخطاء المحتملة:
invoice_already_posted,
invoice_total_required,
invoice_date_required
/api/v1/invoices/{id}/void
النطاق: invoices.void
إلغاء فاتورة مرحّلة. يعكس جميع قيود دفتر الأستاذ ويحدد الفاتورة كملغاة.
الاستجابة HTTP 200
{"success":true,"data":{"id":102,"status":"void"}}
/api/v1/invoices/{id}/mark-sent
النطاق: invoices.send
حدّد فاتورة مسودة على أنها أُرسلت إلى العميل (تتغير الحالة من مسودة إلى غير مدفوعة). العملية لا تتكرر بتأثير إضافي.
الاستجابة HTTP 200
{"success":true,"data":{"id":102,"status":"unpaid"}}
/api/v1/invoices/{id}
النطاق: invoices.delete
احذف فاتورة مسودة وجميع بنودها بشكل دائم. لا يمكن حذف الفواتير المرحّلة أو الفواتير التي لها تخصيصات دفع.
الاستجابة HTTP 200
{"success":true,"data":{"message":"Invoice deleted."}}
الأخطاء المحتملة:
posted_invoice_not_deletable,
invoice_has_allocations
فواتير
/api/v1/bills
النطاق: bills.get
عرض جميع فواتير الموردين. يدعم فلترة الحالة والترقيم.
معلمات الاستعلام
| المعامل | اكتب | الوصف | |
|---|---|---|---|
status |
string |
اختياري | التصفية: draft | unpaid | paid | void
|
page |
integer |
اختياري | رقم الصفحة |
per_page |
integer |
اختياري | النتائج في الصفحة بحد أقصى 100 |
الاستجابة HTTP 200
{"success":true,"data":[{"id":55,"number":"BILL-00055","date":"2026-06-01","status":"draft","total":2000.00,"supplier":{"id":3,"name":"Demo Supplier"}}],"meta":{"current_page":1,"per_page":25,"total":12,"last_page":1}}
/api/v1/bills/{id}
النطاق: bills.get
استرجع فاتورة واحدة مع المورد وبنود السطور.
الاستجابة HTTP 200
{"success":true,"data":{"id":55,"number":"BILL-00055","date":"2026-06-01","due_date":"2026-07-01","status":"draft","reference":"PO-001","total":2000.00,"supplier":{"id":3,"name":"Demo Supplier"},"lines":[]}}
/api/v1/bills
النطاق: bills.post
إنشاء فاتورة مورد جديدة. تُنشأ بالحالة draft ورقم BILL-XXXXX يُولَّد تلقائياً.
نص الطلب (JSON)
| الميدان | اكتب | الوصف | |
|---|---|---|---|
supplier_id |
integer |
مطلوب | معرّف مورد موجود |
date |
date |
مطلوب | تاريخ فاتورة المورد (YYYY-MM-DD) |
due_date |
date |
اختياري | تاريخ استحقاق الدفع |
reference |
string |
اختياري | مرجع المورد / رقم أمر الشراء (بحد أقصى 120) |
notes |
string |
اختياري | ملاحظات داخلية |
subtotal |
decimal |
اختياري | الإجمالي قبل الضريبة، والافتراضي صفر |
tax_total |
decimal |
اختياري | مبلغ الضريبة، والافتراضي صفر |
discount_total |
decimal |
اختياري | الخصم، والافتراضي صفر |
total |
decimal |
اختياري | الإجمالي النهائي، والافتراضي صفر |
الاستجابة HTTP 201
{"success":true,"data":{"id":56,"number":"BILL-00056","status":"draft","date":"2026-06-07","total":2000.00,"supplier_id":3}}
/api/v1/bills/{id}
النطاق: bills.update
تحديث فاتورة مسودة موجودة. جميع الحقول اختيارية.
نص الطلب (JSON)
| الميدان | اكتب | الوصف | |
|---|---|---|---|
supplier_id |
integer |
اختياري | معرّف المورد الجديد |
date |
date |
اختياري | تاريخ الفاتورة |
due_date |
date |
اختياري | تاريخ استحقاق الدفع |
reference |
string |
اختياري | مرجع المورد |
total |
decimal |
اختياري | المجموع الكلي |
الاستجابة HTTP 200
{"success":true,"data":{"id":56,"status":"draft","total":2500.00,"supplier":{"id":3,"name":"Demo Supplier"}}}
/api/v1/bills/{id}/post
النطاق: bills.post
رحّل فاتورة مسودة إلى دفتر الأستاذ العام، مع تسجيل الذمم الدائنة.
الاستجابة HTTP 200
{"success":true,"data":{"id":56,"status":"unpaid","posted_at":"2026-06-07T12:00:00Z"}}
الأخطاء المحتملة:
bill_post_failed
/api/v1/bills/{id}
النطاق: bills.delete
احذف فاتورة مسودة بشكل دائم. يجب أن تكون الفاتورة في حالة مسودة دون أي تخصيصات دفع.
الاستجابة HTTP 200
{"success":true,"data":{"message":"Bill deleted."}}
الأخطاء المحتملة:
posted_bill_not_deletable,
bill_has_allocations
المدفوعات
/api/v1/payments
النطاق: payments.get
عرض جميع الدفعات (المقبوضات والمدفوعات).
معلمات الاستعلام
| المعامل | اكتب | الوصف | |
|---|---|---|---|
type |
string |
اختياري | التصفية: receipt | disbursement
|
status |
string |
اختياري | التصفية: draft | posted
|
page |
integer |
اختياري | رقم الصفحة |
per_page |
integer |
اختياري | النتائج في الصفحة بحد أقصى 100 |
الاستجابة HTTP 200
{"success":true,"data":[{"id":20,"type":"receipt","payment_date":"2026-06-07","amount_total":5000.00,"status":"draft","customer_id":1}],"meta":{"current_page":1,"per_page":25,"total":8,"last_page":1}}
/api/v1/payments
النطاق: payments.post
سجّل إيصال دفع (دفعه العميل) أو صرف (دفعته للمورد). يمكنك اختيارياً تخصيصه مقابل فاتورة أو قائمة مستحقات.
نص الطلب (JSON)
| الميدان | اكتب | الوصف | |
|---|---|---|---|
type |
string |
مطلوب | receipt (دفعة عميل) أو disbursement (دفعة مورد)
|
payment_date |
date |
مطلوب | تاريخ الدفع (YYYY-MM-DD) |
amount_total |
decimal |
مطلوب | إجمالي المبلغ المدفوع (يجب أن يكون أكبر من 0) |
method |
string |
اختياري | طريقة الدفع مثل bank_transfer أو cash أو card |
reference |
string |
اختياري | مرجع البنك أو رقم الشيك (بحد أقصى 120) |
description |
string |
اختياري | الوصف أو المذكرة |
customer_id |
integer |
مش. | مطلوب لمدفوعات الاستلام (يُستنتج من الفاتورة إذا كان document_type=ar_invoice) |
supplier_id |
integer |
مش. | مطلوب لمدفوعات الصرف (يُستنتج من الفاتورة إذا كان document_type=ap_bill) |
document_type |
string |
اختياري | "ar_invoice" أو "ap_bill" — يُفعّل التخصيص التلقائي |
document_id |
integer |
اختياري | معرّف الفاتورة أو الفاتورة المراد التخصيص لها (مطلوب عند تحديد document_type) |
allocated_amount |
decimal |
اختياري | المبلغ المراد توزيعه (الافتراضي هو amount_total) |
الاستجابة HTTP 201
{"success":true,"data":{"id":21,"type":"receipt","payment_date":"2026-06-07","amount_total":5000.00,"status":"draft","allocations":[{"document_type":"ar_invoice","document_id":101,"allocated_amount":5000.00}]}}
الأخطاء المحتملة: document_required وdocument_type_mismatch وinvoice_not_found وbill_not_found وclient_required وsupplier_required
إدخالات دفتر اليومية
/api/v1/journal-entries
النطاق: journal_entries.get
عرض قيود اليومية مع السطور والحسابات. يدعم تصفية نطاق التواريخ.
معلمات الاستعلام
| المعامل | اكتب | الوصف | |
|---|---|---|---|
status |
string |
اختياري | التصفية: draft | posted
|
from |
date |
اختياري | تاريخ البداية (YYYY-MM-DD) |
to |
date |
اختياري | تاريخ النهاية (YYYY-MM-DD) |
page |
integer |
اختياري | رقم الصفحة |
per_page |
integer |
اختياري | النتائج في الصفحة بحد أقصى 100 |
الاستجابة HTTP 200
{"success":true,"data":[{"id":5,"entry_date":"2026-06-07","reference":"JE-001","status":"posted","lines_count":2}],"meta":{"current_page":1,"per_page":25,"total":5,"last_page":1}}
/api/v1/journal-entries
النطاق: journal_entries.post
إنشاء قيد يومية متوازن وترحيله فورًا. يجب أن يساوي مجموع المدين مجموع الدائن (بهامش ±0.01).
نص الطلب (JSON)
| الميدان | اكتب | الوصف | |
|---|---|---|---|
date |
date |
مطلوب | تاريخ القيد (YYYY-MM-DD) |
reference |
string |
اختياري | رمز المرجع، مثل JE-001 (بحد أقصى 120 حرفًا) |
description |
string |
اختياري | المذكرة أو الوصف بحد أقصى 2000 حرف |
lines |
array |
مطلوب | خطان على الأقل. كل سطر: account_id (مطلوب)، وdebit (عشري)، وcredit (عشري)، وdescription (نص) |
الاستجابة HTTP 201
{"success":true,"data":{"id":6,"entry_date":"2026-06-07","reference":"JE-001","status":"posted","posted_at":"2026-06-07T12:00:00Z","lines":[{"account_id":101,"account":{"code":"1100","name":"Cash"},"debit":1000,"credit":0},{"account_id":202,"account":{"code":"3000","name":"Equity"},"debit":0,"credit":1000}]}}
الأخطاء المحتملة:
journal_not_balanced
/api/v1/journal-entries/{id}
النطاق: journal_entries.delete
احذف قيد يومية غير مرحّل. لا يمكن حذف القيود المرحّلة عبر واجهة البرمجة.
الاستجابة HTTP 200
{"success":true,"data":{"message":"Journal entry deleted."}}
الأخطاء المحتملة:
posted_journal_not_deletable
التقارير
تقبل جميع تقارير النظام المعامل ?from=YYYY-MM-DD&to=YYYY-MM-DD. وتقبل تقارير الميزانية العمومية وميزان المراجعة وتقادم الديون أيضًا ?as_of=YYYY-MM-DD (بما يعادل to).
/api/v1/reports/income-statement
النطاق: reports.income_statement
تقرير الأرباح والخسائر. يعرض الإيرادات والمصروفات وصافي الدخل للفترة المحددة.
معلمات الاستعلام
| المعامل | اكتب | الوصف | |
|---|---|---|---|
from |
date |
اختياري | بداية الفترة (YYYY-MM-DD) |
to |
date |
اختياري | نهاية الفترة (YYYY-MM-DD) |
الاستجابة HTTP 200
{"success":true,"data":{"revenue":150000,"expenses":85000,"net_income":65000}}
/api/v1/reports/balance-sheet
النطاق: reports.balance_sheet
لقطة الميزانية العمومية. تُرجع الأصول والخصوم وحقوق الملكية في التاريخ المحدد.
معلمات الاستعلام
| المعامل | اكتب | الوصف | |
|---|---|---|---|
to |
date |
اختياري | تاريخ الاستعلام (YYYY-MM-DD). ويُقبل أيضاً بالصيغة ?as_of= |
الاستجابة HTTP 200
{"success":true,"data":{"assets":{"total":250000},"liabilities":{"total":80000},"equity":{"total":170000}}}
/api/v1/reports/cash-flow
النطاق: reports.cash_flow
بيان التدفقات النقدية للفترة المحددة (الطريقة المباشرة).
معلمات الاستعلام
| المعامل | اكتب | الوصف | |
|---|---|---|---|
from |
date |
اختياري | بداية الفترة |
to |
date |
اختياري | نهاية الفترة |
الاستجابة HTTP 200
{"success":true,"data":{"operating":45000,"investing":-12000,"financing":-8000,"net_change":25000}}
/api/v1/reports/trial-balance
النطاق: reports.trial_balance
ميزان المراجعة الذي يعرض جميع الحسابات مع إجماليات المدين والدائن حتى تاريخ معين.
معلمات الاستعلام
| المعامل | اكتب | الوصف | |
|---|---|---|---|
to |
date |
اختياري | التاريخ المرجعي (YYYY-MM-DD) |
الاستجابة HTTP 200
{"success":true,"data":[{"account_code":"1100","account_name":"Cash","debit":50000,"credit":0},{"account_code":"2000","account_name":"Accounts Payable","debit":0,"credit":15000}]}
/api/v1/reports/ar-aging
النطاق: reports.ar_aging
أعمار الذمم المدينة. فواتير العملاء غير المسددة مصنفة حسب مدة تأخرها.
معلمات الاستعلام
| المعامل | اكتب | الوصف | |
|---|---|---|---|
to |
date |
اختياري | التاريخ المرجعي لأعمار الديون (YYYY-MM-DD) |
الاستجابة HTTP 200
{"success":true,"data":{"current":12000,"1_30":3500,"31_60":800,"61_90":0,"over_90":500,"total":16800}}
/api/v1/reports/ap-aging
النطاق: reports.ap_aging
أعمار ذمم الموردين الدائنة. فواتير الموردين غير المسددة مصنفة حسب مدة تأخرها.
معلمات الاستعلام
| المعامل | اكتب | الوصف | |
|---|---|---|---|
to |
date |
اختياري | التاريخ المرجعي لأعمار الديون (YYYY-MM-DD) |
الاستجابة HTTP 200
{"success":true,"data":{"current":8000,"1_30":1200,"31_60":0,"61_90":0,"over_90":0,"total":9200}}
/api/v1/reports/tax
النطاق: reports.tax
ملخص ضريبة القيمة المضافة / الضريبة. يعرض الضريبة المحصلة على المبيعات والضريبة المدفوعة على المشتريات للفترة.
معلمات الاستعلام
| المعامل | اكتب | الوصف | |
|---|---|---|---|
from |
date |
اختياري | بداية الفترة |
to |
date |
اختياري | نهاية الفترة |
الاستجابة HTTP 200
{"success":true,"data":{"tax_collected":15000,"tax_paid":4200,"net_vat_payable":10800}}
مرجع الأخطاء
| رمز الخطأ | HTTP | معنى |
|---|---|---|
invoice_already_posted |
422 | الفاتورة مُرحّلة بالفعل إلى دفتر الأستاذ |
invoice_total_required |
422 | لا يمكن ترحيل فاتورة إجماليها صفر أو سالب |
invoice_date_required |
422 | تاريخ المستند مطلوب قبل الترحيل |
posted_invoice_not_deletable |
422 | ألغِ الفاتورة أو ألغِ ترحيلها قبل الحذف |
invoice_has_allocations |
422 | أزل تخصيصات الدفع قبل الحذف |
posted_bill_not_deletable |
422 | لا يمكن حذف فاتورة مرحّلة أو غير مسودة |
bill_has_allocations |
422 | أزل تخصيصات الدفع قبل الحذف |
bill_post_failed |
422 | فشلت الفاتورة في التحقق الداخلي من الترحيل |
journal_not_balanced |
422 | إجمالي المدين لا يساوي إجمالي الدائن |
posted_journal_not_deletable |
422 | لا يمكن حذف إلا القيود المسودة (غير المرحّلة) |
document_required |
422 | document_id مطلوب عندما يكون document_type محددًا
|
document_type_mismatch |
422 | ar_invoice يتطلب receipt؛ وap_bill يتطلب disbursement
|
invoice_not_found |
404 | لا توجد فاتورة بهذا المعرّف |
bill_not_found |
404 | لا توجد فاتورة بهذا المعرّف |
client_required |
422 | customer_id مطلوب للدفعات receipt
|
supplier_required |
422 | supplier_id مطلوب للدفعات disbursement
|
ترقيم الصفحات
تُرجع جميع نقاط نهاية القوائم نتائج مقسّمة إلى صفحات. تحكّم في الترقيم بمعاملات الاستعلام:
| المعامل | الافتراضي | الحد الأقصى | الوصف |
|---|---|---|---|
page | 1 | — | رقم الصفحة المطلوب جلبها |
per_page | 25 | 100 | عدد النتائج في الصفحة |
يحتوي كائن meta في كل استجابة قائمة على current_page وper_page وtotal وlast_page.