agency-invoicing

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

One client, with their whole invoice history.

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। कुञ्जीसँग agency.invoicing.view अनुमति हुनुपर्छ; अनुमति नभएको कुञ्जीलाई 404 होइन, 403 मार्फत अस्वीकार गरिन्छ।

तपाईंको संस्थाको आइडी राख्ने ठाउँ

यो इन्डपोइन्टले org_id लाई क्वेरी प्यारामिटरको रूपमा लिन्छ। यसलाई छुटाउनुभयो भने कलले तपाईंको सम्पूर्ण टेनेन्सी सबट्रीलाई समेट्छ; यसलाई एउटा संस्थामा मात्र सीमित गर्न पठाउनुहोस्।

तपाईंको संस्थाको आइडी (ID) तपाईंको ड्यासबोर्डमा रहेको API कुञ्जीहरू (keys) स्क्रिनमा, कुञ्जीको छेउमा हुन्छ। तपाईंले गर्ने प्रत्येक कलमा यही आइडी प्रयोग हुन्छ।

प्रयास गर्नुहोस्

कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।

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`	हुन्छ	—
`country`	`string`	हैन	ISO-3166-1 alpha-2, optional. Required only to bill this client on Zinn®'s own checkout (the platform organisation, docs/670 §3), where the country decides the VAT on the bill and…
`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}