الفواتير

يتطلب مفتاح API — انظر المصادقة. للقراءة فقط (GET).

قائمة الفواتير

GET /v1/invoices

معاملات الاستعلام

المعامل	النوع	الافتراضي	ملاحظات
limit	integer	50	الحد الأقصى 200.
offset	integer	0
status	string	—	مطابقة تامة (مثل paid أو overdue). أغفله لإرجاع الفواتير بأي حالة.

النتائج مرتّبة من الأحدث إلى الأقدم حسب تاريخ الإنشاء، لكن لاحظ أن طابع الإنشاء الزمني نفسه غير مضمَّن في حقول الاستجابة (انظر أدناه).

مثال طلب

curl -H "Authorization: Bearer lk_YOUR_KEY" \
  "https://tenant.logistall.cloud/api/v1/invoices?status=overdue&limit=2"

مثال استجابة

[
  {
    "id": "5d6e7f8a-9b0c-1d2e-3f4a-5b6c7d8e9f0a",
    "invoiceNumber": "INV-00214",
    "status": "overdue",
    "totalAmount": 48250.5,
    "paidAmount": 20000,
    "currencyCode": "MAD",
    "invoiceDate": "2026-06-12T00:00:00.000Z",
    "dueDate": "2026-07-02T00:00:00.000Z"
  },
  {
    "id": "6e7f8a9b-0c1d-2e3f-4a5b-6c7d8e9f0a1b",
    "invoiceNumber": "INV-00198",
    "status": "overdue",
    "totalAmount": 15600,
    "paidAmount": 0,
    "currencyCode": "MAD",
    "invoiceDate": "2026-06-05T00:00:00.000Z",
    "dueDate": "2026-06-25T00:00:00.000Z"
  }
]

قيمة status واحدة من draft أو sent أو partial أو paid أو overdue أو void أو disputed. أما totalAmount وpaidAmount فهما رقمان (لا سلسلتان نصيتان) بعملة currencyCode — والعملة الأساس عبر المنصة هي MAD، وإن كانت سجلات مستأجر ما قد تستخدم عملات أخرى.

الحقول المُعادة

الحقل	ملاحظات
id
invoiceNumber
status
totalAmount	رقمي
paidAmount	رقمي
currencyCode
invoiceDate
dueDate

لا يوجد حقل createdAt في نقطة النهاية هذه (فهو يُستخدم داخليًا لترتيب النتائج فقط)، ولا تفاصيل بنود — للاطلاع على فاتورة كاملة ببنودها وملف PDF الخاص بها، انظر صفحة المالية في دليل المستخدم.

الأخطاء

الحالة	المتن	متى
401	انظر المصادقة	مفتاح مفقود/غير صالح.
500	{ "error": "Database error" }	خطأ غير متوقع في الخادم.

لا توجد حاليًا نقطة نهاية لفاتورة واحدة (GET /v1/invoices/:id) — القائمة فقط.