المطورون

العملاء في الواجهة البرمجية

نقاط نهاية العملاء، وكيف يُربط المشتري بالفاتورة (بالمعرّف أو بالبيانات المباشرة)، وما تشترطه الهيئة للمشترين من المنشآت.

نقاط النهاية

POST /api/v1/invoices
متاح اربط عميلًا موجودًا بمعرّفه، أو أنشئ عميلًا من البيانات المباشرة، ضمن الفاتورة.
GET /api/v1/customers
متاح عرض العملاء والبحث فيهم.
POST /api/v1/customers
متاح إنشاء عميل بعنوانه الوطني كاملًا.
GET /api/v1/customers/{id}
متاح جلب عميل.
PATCH /api/v1/customers/{id}
متاح تعديل عميل.

عميل موجود بمعرّفه

أرسل معرّف عميل من عملاء منشأتك. المعرّف التابع لمنشأة أخرى يُعامل تمامًا كمعرّف غير موجود: 422 customer_not_found.

{
  "issue_date": "2026-11-03",
  "customer": { "id": 381 },
  "items": [{ "description": "Monthly plan", "quantity": 1, "unit_price": 99 }]
}

عميل من البيانات المباشرة

أرسل بيانات المشتري بدل المعرّف فتحفظها وندرفاتورة عميلًا جديدًا (ويسري حد العملاء في باقتك). المشتري الذي له رقم ضريبي يُحفظ منشأة، ومن لا رقم له يُحفظ فردًا. الإنشاء من البيانات المباشرة لا يحتاج إلا invoices:write.

{
  "issue_date": "2026-11-03",
  "customer": {
    "name": "Example Trading Co.",
    "vat_number": "300000000000003",
    "email": "billing@example.com",
    "phone": "0500000000",
    "address_line1": "King Fahd Rd",
    "city": "Riyadh",
    "postal_code": "12345",
    "country": "SA"
  },
  "items": [{ "description": "Monthly plan", "quantity": 1, "unit_price": 99 }]
}
البيانات المباشرة تنشئ دائمًا عميلًا جديدًا. احفظ data.invoice.customer.id من الرد مع سجل العميل لديك، وأرسل {"id": …} في المرة التالية لتجنب التكرار.

دون عميل

اترك customer، أو لا ترسل name، لعملية بيع لمستهلك دون اسم. تكون الفاتورة فاتورة ضريبية مبسطة.

المشترون من المنشآت والهيئة

الفاتورة لمشترٍ له رقم ضريبي سعودي صالح هي فاتورة ضريبية قياسية. في المنشأة المرتبطة بالهيئة تُعتمد قبل وصولها إلى المشتري، وتشترط الهيئة العنوان الوطني الكامل للمشتري:

الجزء الشرط
الشارع مطلوب
رقم المبنى 4 أرقام
الحي مطلوب
المدينة مطلوبة
الرمز البريدي 5 أرقام

البيانات المباشرة في الفاتورة لا تحمل رقم المبنى ولا الحي. للمشترين من المنشآت، أنشئ العميل مرة واحدة عبر POST /customers (أو من لوحة التحكم) بعنوانه الكامل وأرسل معرّفه. أما المشتري خارج المملكة فيحتاج الشارع والمدينة.

الأرقام الضريبية

الرقم الضريبي السعودي 15 خانة يبدأ بـ 3 وينتهي بـ 3، والرقم غير الصحيح يُرفض بـ 422. للمشتري خارج المملكة اجعل country رمز دولته (مثل AE) وأرسل رقمه الضريبي هناك، ولا يخضع للصيغة السعودية.

تحتاج نقاط نهاية العملاء صلاحية customers:read للعرض والقراءة، وcustomers:write للإنشاء والتعديل. البريد والجوال والرقم الضريبي فريدة داخل منشأتك. راجع مرجع الواجهة البرمجية.

جاهز للبدء؟

الوصول إلى الواجهة البرمجية ضمن باقات: الأعمال والمؤسسات. أنشئ مفتاحًا من الإعدادات ← مفاتيح API وأرسل أول طلب خلال دقائق.