agency-invoicing

GET `/v1/agency-invoicing/clients/{clientId}`

One client, with their whole invoice history.

توثيقِ شناخت

ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس agency.invoicing.view اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔

جہاں آپ کی تنظیم کی آئی ڈی آتی ہے

یہ اینڈ پوائنٹ org_id کو بطور کوئری پیرامیٹر لیتا ہے۔ اسے چھوڑ دیں اور کال آپ کے پورے ٹیننسی سب ٹری کا احاطہ کرے گی؛ کال کو کسی ایک آرگنائزیشن تک محدود کرنے کے لیے اسے بھیجیں۔

آپ کی تنظیم کی آئی ڈی آپ کے ڈیش بورڈ پر API کیز کی سکرین پر، خود کلید کے ساتھ موجود ہوتی ہے۔ یہ آپ کی کی جانے والی ہر کال میں ایک ہی آئی ڈی ہوتی ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

curl -X GET https://api.zinndigital.com/v1/agency-invoicing/clients/{clientId} \
  -H "Authorization: Bearer zdk_live_…"

لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں

تفصیلات

⭐ Every invoice you have raised against them, what they still owe and what they have been billed in total — the "all client history" screen in one request rather than a filtered list. Requires `agency.invoicing.view`.

پیرامیٹرز

نام	قسم	لازمی	یہ کیا ہے
`clientId (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…

جواب

نام	قسم	لازمی	یہ کیا ہے
`id`	`Uuid`	ہاں	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	ہاں	—
`contact_name`	`string`	نہیں	—
`email`	`string`	نہیں	—
`phone`	`string`	نہیں	—
`address`	`string`	نہیں	—
`tax_number_label`	`string`	نہیں	—
`tax_number`	`string`	نہیں	—
`currency`	`string`	ہاں	—
`locale`	`string`	نہیں	Which language this client's invoices and payment page render in. An agency in Berlin invoicing a French client sends a French invoice.
`notes`	`string`	نہیں	—
`archived`	`boolean`	نہیں	—
`created_at`	`string`	نہیں	—
`invoices`	`AgencyInvoice[]`	نہیں	—
`outstanding_minor`	`integer`	نہیں	What this client still owes, in minor units.
`invoiced_total_minor`	`integer`	نہیں	Everything ever billed to them, void invoices excluded.

وہ خرابیان جو یہ اینڈ پوائنٹ واپس کر سکتا ہے

401 · 403 · 404 · 429

GET /v1/agency-invoicing/clients/{clientId}