agency-invoicing

PATCH `/v1/agency-invoicing/profile`

Change your invoicing identity or defaults.

المصادقة

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

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

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

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

جربه الآن

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

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

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

التفاصيل

⛔ `next_number` is deliberately NOT settable. Rewinding a sequence would mint a duplicate number for a document already in a client's hands; advancing it leaves a gap a tax authority will ask about. Requires `agency.invoicing.manage`.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`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…

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`business_name`	`string`	لا	—
`address`	`string`	لا	—
`email`	`string`	لا	—
`phone`	`string`	لا	—
`website`	`string`	لا	—
`tax_number_label`	`string`	لا	—
`tax_number`	`string`	لا	—
`payment_instructions`	`string`	لا	—
`logo_sha256`	`string`	لا	—
`accent_colour`	`string`	لا	—
`default_currency`	`string`	لا	—
`default_payment_terms_days`	`integer`	لا	—
`default_footer`	`string`	لا	—
`default_notes`	`string`	لا	—
`number_prefix`	`string`	لا	—
`number_padding`	`integer`	لا	—

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`business_name`	`string`	لا	—
`address`	`string`	لا	The registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema.
`email`	`string`	لا	—
`phone`	`string`	لا	—
`website`	`string`	لا	—
`tax_number_label`	`string`	لا	What the agency calls its tax registration — "VAT number", "ABN", "GSTIN", "EIN". ⛔ Printed only when the number is set too: a label with no number is an empty row, and a number…
`tax_number`	`string`	لا	—
`payment_instructions`	`string`	لا	Bank details or a "PayPal me at …" line, printed on the document verbatim and shown on the payment page. ⭐ Never translated — translating a payment instruction is not a safe act.
`logo_sha256`	`string`	لا	A digest into the content-addressed logo store, never a URL. That is what lets the PDF inline the mark with no network call at render time.
`accent_colour`	`string`	لا	—
`default_currency`	`string`	نعم	—
`default_payment_terms_days`	`integer`	لا	—
`default_footer`	`string`	لا	—
`default_notes`	`string`	لا	—
`number_prefix`	`string`	نعم	—
`number_padding`	`integer`	لا	—
`next_number`	`integer`	نعم	The next sequence number. ⛔ Read-only. Rewinding it would mint a duplicate number for a document already in a client's hands.
`next_number_preview`	`string`	لا	What the next invoice will be called, e.g. `INV-0042`.

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

401 · 403 · 404 · 422 · 429

PATCH /v1/agency-invoicing/profile