agency-invoicing

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

Change a client's details.

تصدیق‌هویت

د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.

چیرته چې ستاسو د سازمان آی ډي ځي

دا پای ټکی د پوښتنې پیرامیتر په توګه org_id اخلي. دا پریږدئ او زنګ ستاسو د استوګنې ټولې څانګې پوښي؛ د یوې سازمان لپاره د زنګ محدودولو لپاره یې واستوئ.

ستاسو د سازمان آی ډي ستاسو په ډشبورډ کې د API کېلي پر سکرین، خپله د کېلي څنګ ته شتون لري. دا په هره هغه غوښتنه کې چې تاسو یې کوئ، ورته آی ډي وي.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د API په کنسول کې پرانیزئ

پارامترونه

نوم	ډول	اړین	دا څه شی دی
`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…

د غوښتنې بدن

نوم	ډول	اړین	دا څه شی دی
`name`	`string`	نه	—
`contact_name`	`string`	نه	—
`email`	`string`	نه	—
`phone`	`string`	نه	—
`address`	`string`	نه	—
`tax_number_label`	`string`	نه	—
`tax_number`	`string`	نه	—
`currency`	`string`	نه	—
`country`	`string`	نه	Two-letter ISO code, or empty or null to clear. Anything else is refused.
`locale`	`string`	نه	—
`notes`	`string`	نه	—
`archived`	`boolean`	نه	—

ځواب

نوم	ډول	اړین	دا څه شی دی
`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`	نه	—

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

401 · 403 · 404 · 422 · 429

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