reseller

PUT `/v1/reseller/legal-entity`

Save the company details your clients' invoices are issued under.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن reseller.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

حيث يتم إدخال معرف مؤسستك

تأخذ نقطة النهاية هذه org_id كمعلمة استعلام. اتركه فارغاً ليغطي الاستدعاء شجرة مستأجريك بالكامل، أو أرسله لتضييق نطاق الاستدعاء ليشمل منظمة واحدة.

معرف مؤسستك موجود على شاشة مفاتيح واجهة برمجة التطبيقات (API) في لوحة تحكمك، بجوار المفتاح نفسه. وهو نفس المعرف في كل طلب تجريه.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

curl -X PUT https://api.zinndigital.com/v1/reseller/legal-entity \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "country": <string>, "number_prefix": <string> }'

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API

التفاصيل

Creates the entity the first time and updates it afterwards — never a second row. `number_prefix` is **globally unique across every company on the platform** because it is what keeps two issuers' invoice numbers apart, so a value already in use is a 409; and it **freezes once an invoice has been issued** under this company, because releasing it would let the next taker mint numbers you have already issued. Everything else stays editable — a company that moves office must be able to say so. Requires `reseller.manage`.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`org_id (query)`	`Uuid`	لا	Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404 r…

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`id`	`Uuid`	لا	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	نعم	—
`company_number`	`string`	لا	—
`address_line1`	`string`	لا	—
`address_line2`	`string`	لا	—
`city`	`string`	لا	—
`region`	`string`	لا	—
`postcode`	`string`	لا	—
`country`	`string`	نعم	ISO 3166-1 alpha-2. Stored uppercase.
`vat_number`	`string`	لا	—
`footer_text`	`string`	لا	—
`number_prefix`	`string`	نعم	The prefix in every invoice number you issue (`AG-INV-2026-000123`). Globally unique across all companies on the platform, and frozen once you have issued an invoice.
`number_prefix_locked`	`boolean`	لا	True once an invoice has been issued under this company.
`created_at`	`string`	لا	—
`updated_at`	`string`	لا	—

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`data`	`ResellerLegalEntity \| null`	نعم	`null` when no company details are held yet.

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 404 · 409 · 422 · 429

PUT /v1/reseller/legal-entity