agency-invoicing

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

Change a client's details.

การยืนยันตัวตน

ส่ง API key เป็น bearer token เอนด์พอยต์นี้ไม่ได้ระบุสิทธิ์การใช้งานเฉพาะในข้อกำหนด ดังนั้นควรให้คีย์ของคุณมีสิทธิ์น้อยที่สุดเท่าที่จำเป็นและให้ตรวจสอบจากการตอบกลับแทนที่จะคาดเดา

ตำแหน่งสำหรับใส่รหัสองค์กรของคุณ

พอยต์ข้อมูลนี้รับ 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 ในแดชบอร์ดของคุณจะเติมรหัสองค์กรจริงและคีย์ของคุณเองโดยอัตโนมัติ และทำการส่งคำขอไปยัง 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}