agency-invoicing
PATCH /v1/agency-invoicing/profile
Change your invoicing identity or defaults.
การยืนยันตัวตน
ส่ง API key ในรูปแบบ bearer token คีย์ดังกล่าวต้องมีสิทธิ์ agency.invoicing.manage หากไม่มีสิทธิ์ ระบบจะปฏิเสธด้วยรหัส 403 แทนที่จะเป็น 404
ตำแหน่งสำหรับใส่รหัสองค์กรของคุณ
พอยต์ข้อมูลนี้รับ org_id เป็นพารามิเตอร์คิวรี หากเว้นว่างไว้ การเรียกใช้งานจะครอบคลุมย่อยของเทแนนท์ทั้งหมดของคุณ แต่หากระบุค่า จะช่วยจำกัดขอบเขตการเรียกให้เหลือเพียงองค์กรเดียว
รหัสองค์กรของคุณจะแสดงอยู่บนหน้าคีย์ API ในแดชบอร์ดของคุณ โดยอยู่ถัดจากคีย์นั้นๆ รหัสนี้จะเป็นรหัสเดิมในการเรียกใช้งานทุกครั้งของคุณ
ทดลองใช้เลย
แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ
curl -X PATCH https://api.zinndigital.com/v1/agency-invoicing/profile \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'เข้าสู่ระบบแล้วใช่ไหม คอนโซล API ในแดชบอร์ดของคุณจะเติมรหัสองค์กรจริงและคีย์ของคุณเองโดยอัตโนมัติ และทำการส่งคำขอไปยัง API จริง เพื่อให้คุณเห็นผลลัพธ์ที่เป็นข้อมูลจริง เปิดจุดสิ้นสุดนี้ในคอนโซล API
รายละเอียด
⛔ `next_number` is deliberately NOT settable. Rewinding a sequence would mint a duplicate number for a document already in a client's hands; advancing it leaves a gap a tax authority will ask about. Requires `agency.invoicing.manage`.
พารามิเตอร์
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
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… |
เนื้อหาคำขอ
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
business_name | string | ไม่ใช่ | — |
address | string | ไม่ใช่ | — |
email | string | ไม่ใช่ | — |
phone | string | ไม่ใช่ | — |
website | string | ไม่ใช่ | — |
tax_number_label | string | ไม่ใช่ | — |
tax_number | string | ไม่ใช่ | — |
payment_instructions | string | ไม่ใช่ | — |
logo_sha256 | string | ไม่ใช่ | — |
accent_colour | string | ไม่ใช่ | — |
default_currency | string | ไม่ใช่ | — |
default_payment_terms_days | integer | ไม่ใช่ | — |
default_footer | string | ไม่ใช่ | — |
default_notes | string | ไม่ใช่ | — |
number_prefix | string | ไม่ใช่ | — |
number_padding | integer | ไม่ใช่ | — |
การตอบกลับ
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
business_name | string | ไม่ใช่ | — |
address | string | ไม่ใช่ | The registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema. |
email | string | ไม่ใช่ | — |
phone | string | ไม่ใช่ | — |
website | string | ไม่ใช่ | — |
tax_number_label | string | ไม่ใช่ | What the agency calls its tax registration — "VAT number", "ABN", "GSTIN", "EIN". ⛔ Printed only when the number is set too: a label with no number is an empty row, and a number… |
tax_number | string | ไม่ใช่ | — |
payment_instructions | string | ไม่ใช่ | Bank details or a "PayPal me at …" line, printed on the document verbatim and shown on the payment page. ⭐ Never translated — translating a payment instruction is not a safe act. |
logo_sha256 | string | ไม่ใช่ | A digest into the content-addressed logo store, never a URL. That is what lets the PDF inline the mark with no network call at render time. |
accent_colour | string | ไม่ใช่ | — |
default_currency | string | ใช่ | — |
default_payment_terms_days | integer | ไม่ใช่ | — |
default_footer | string | ไม่ใช่ | — |
default_notes | string | ไม่ใช่ | — |
number_prefix | string | ใช่ | — |
number_padding | integer | ไม่ใช่ | — |
next_number | integer | ใช่ | The next sequence number. ⛔ Read-only. Rewinding it would mint a duplicate number for a document already in a client's hands. |
next_number_preview | string | ไม่ใช่ | What the next invoice will be called, e.g. `INV-0042`. |
ข้อผิดพลาดที่เอนด์พอยต์นี้สามารถส่งกลับได้
401 · 403 · 404 · 422 · 429