agency-invoicing
GET /v1/agency-invoicing/clients/{clientId}
One client, with their whole invoice history.
প্রমাণীকরণ
একটি বিয়ারার টোকেন হিসেবে একটি এপিআই কি পাঠান। কি-টির অবশ্যই agency.invoicing.view অনুমতি থাকতে হবে; এটি ছাড়া কোনো কি ৪০৪ নয়, বরং ৪০৩ ত্রুটি দিয়ে প্রত্যাখ্যাত হবে।
যেখানে আপনার অর্গানাইজেশন আইডি দেওয়া হবে
এই এন্ডপয়েন্টটি org_id-কে একটি কুয়েরি প্যারামিটার হিসেবে গ্রহণ করে। এটি বাদ দিলে কলটি আপনার পুরো টেনেন্সি সাবট্রিকে কভার করে; এটিকে পাঠালে কলটি একটি সংস্থায় সীমাবদ্ধ হয়।
আপনার ড্যাশবোর্ডের API কি স্ক্রিনে, কি-এর ঠিক পাশেই আপনার অর্গানাইজেশন আইডি রয়েছে। আপনি যে কলই করুন না কেন, সবগুলিতেই এই আইডি একই থাকে।
চেষ্টা করুন
কোণ বন্ধনীতে থাকা যেকোনো কিছু আপনার নিজস্ব মান দিয়ে এবং কী প্লেসহোল্ডারটি আপনার ড্যাশবোর্ডের একটি কী দিয়ে প্রতিস্থাপন করুন।
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/clients/{clientId} \
-H "Authorization: Bearer zdk_live_…"লগ ইন করা আছে? আপনার ড্যাশবোর্ডের এপিআই কনসোল আপনার আসল অর্গানাইজেশন আইডি এবং আপনার নিজের কি পূরণ করে দেয়, এবং লাইভ এপিআই-এর বিপরীতে অনুরোধটি চালায় যাতে আপনি প্রকৃত প্রতিক্রিয়া দেখতে পান। এই এন্ডপয়েন্টটি এপিআই কনসোলে খুলুন
বিবরণ
⭐ 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