agency-invoicing

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

Change a client's details.

Баталгаажуулалт

API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Энэхүү төгсгөлийн цэг нь тодорхойлолтдоо тодорхой зөвшөөрлийг заагаагүй тул түлхүүрээрээ шаардагдах хамгийн бага эрхийг өгч, таамаглахаас илүүтэйгээр хариуг шалгана уу.

Таны байгууллагын дугаар орох газар

Энэ төгсгөл цэг нь org_id-г асуулгын параметр болгон авдаг. Үүнийг орхивол дуудлага таны бүх түрээсийн дэд модыг хамрах бөгөөд дуудлагыг зөвхөн нэг байгууллагаар хязгаарлахын тулд үүнийг илгээнэ үү.

Танай байгууллагын ID нь таны хяналтын самбар дээрх API түлхүүрийн дэлгэцэнд, түлхүүр өөрөө хажууд байрладаг. Энэ нь таны хийх дуудлага бүрт ижил ID байна.

Туршиж үзэх

Өнцөг хаалтанд байгаа бүх зүйлийг өөрийн утгаар солиж, түлхүүр санамж байрлуулагчийг хяналтын самбарынхаа түлхүүрээр сольж оруулна уу.

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 рүү хүсэлт илгээх тул та бодит хариуг харах боломжтой болно. Энэ төгсгөлийн цэгийг 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`	Үгүй	—
`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`	Тийм	—
`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}