agency-invoicing

PATCH `/v1/agency-invoicing/tax-rates/{rateId}`

Change a tax rate.

المصادقة

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

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

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

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

جربه الآن

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

curl -X PATCH https://api.zinndigital.com/v1/agency-invoicing/tax-rates/{rateId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

التفاصيل

⭐ Changing a rate does NOT restate any invoice that already carries it — the percentage and the name are copied onto each line when it is saved. That is what lets you move VAT from 20% to 17.5% next April without rewriting last month. Requires `agency.invoicing.manage`.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`rateId (path)`	`Uuid`	نعم	—
`org_id (query)`	`Uuid`	لا	Which of your organizations is invoicing. Required only when you belong to more than one — otherwise it is inferred from your DIRECT membership, never from the subtree-expanded…

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`name`	`string`	لا	—
`rate_bps`	`integer`	لا	—
`registration_number`	`string`	لا	—
`note`	`string`	لا	—
`is_default`	`boolean`	لا	—

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	نعم	What the document calls it. ⛔ Free text, not an enum: the line must read "VAT", "MwSt.", "TVA" or "Sales tax" depending on who is being invoiced.
`rate_bps`	`integer`	نعم	—
`registration_number`	`string`	لا	—
`note`	`string`	لا	—
`is_default`	`boolean`	لا	—

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

401 · 403 · 404 · 422 · 429

PATCH /v1/agency-invoicing/tax-rates/{rateId}