agency-invoicing

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

Change a client's details.

Autentikasi

Kirimkan kunci API sebagai token bearer. Titik akhir ini tidak menyatakan izin tertentu dalam spesifikasi, jadi berikan kunci Anda izin minimum yang diperlukan dan periksa responsnya alih-alih berasumsi.

Tempat ID organisasi Anda dimasukkan

Titik akhir ini menerima org_id sebagai parameter kueri. Kosongkan parameter tersebut dan panggilan ini akan mencakup seluruh subpohon penyewa Anda; kirimkan untuk mempersempit panggilan ke satu organisasi.

ID organisasi Anda berada di layar kunci API di dasbor Anda, di sebelah kunci itu sendiri. Itu adalah ID yang sama dalam setiap panggilan yang Anda buat.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Parameter

Nama	Jenis	Wajib	Tentang apa ini
`clientId (path)`	`Uuid`	Ya	—
`org_id (query)`	`Uuid`	Tidak	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…

Isi permintaan

Nama	Jenis	Wajib	Tentang apa ini
`name`	`string`	Tidak	—
`contact_name`	`string`	Tidak	—
`email`	`string`	Tidak	—
`phone`	`string`	Tidak	—
`address`	`string`	Tidak	—
`tax_number_label`	`string`	Tidak	—
`tax_number`	`string`	Tidak	—
`currency`	`string`	Tidak	—
`locale`	`string`	Tidak	—
`notes`	`string`	Tidak	—
`archived`	`boolean`	Tidak	—

Tanggapan

Nama	Jenis	Wajib	Tentang apa ini
`id`	`Uuid`	Ya	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Ya	—
`contact_name`	`string`	Tidak	—
`email`	`string`	Tidak	—
`phone`	`string`	Tidak	—
`address`	`string`	Tidak	—
`tax_number_label`	`string`	Tidak	—
`tax_number`	`string`	Tidak	—
`currency`	`string`	Ya	—
`locale`	`string`	Tidak	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`	Tidak	—
`archived`	`boolean`	Tidak	—
`created_at`	`string`	Tidak	—

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422 · 429