agency-invoicing
PATCH /v1/agency-invoicing/profile
Change your invoicing identity or defaults.
Xác thực
Gửi khóa API dưới dạng mã thông báo bearer. Khóa này phải có quyền agency.invoicing.manage; khóa không có quyền này sẽ bị từ chối với mã lỗi 403, không phải 404.
Nơi điền id tổ chức của bạn
Điểm cuối này nhận org_id làm tham số truy vấn. Hãy bỏ trống để áp dụng cho toàn bộ cây thuê của bạn; hoặc truyền giá trị vào để thu hẹp phạm vi gọi về một tổ chức duy nhất.
Mã tổ chức của bạn nằm ở màn hình khóa API trong bảng điều khiển, ngay bên cạnh khóa đó. Đây là cùng một mã trong mọi lệnh gọi mà bạn thực hiện.
Dùng thử
Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.
curl -X PATCH https://api.zinndigital.com/v1/agency-invoicing/profile \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API
Chi tiết
⛔ `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`.
Tham số
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
org_id (query) | Uuid | Không | 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… |
Nội dung yêu cầu
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
business_name | string | Không | — |
address | string | Không | — |
email | string | Không | — |
phone | string | Không | — |
website | string | Không | — |
tax_number_label | string | Không | — |
tax_number | string | Không | — |
payment_instructions | string | Không | — |
logo_sha256 | string | Không | — |
accent_colour | string | Không | — |
default_currency | string | Không | — |
default_payment_terms_days | integer | Không | — |
default_footer | string | Không | — |
default_notes | string | Không | — |
number_prefix | string | Không | — |
number_padding | integer | Không | — |
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
business_name | string | Không | — |
address | string | Không | The registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema. |
email | string | Không | — |
phone | string | Không | — |
website | string | Không | — |
tax_number_label | string | Không | 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 | Không | — |
payment_instructions | string | Không | 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 | Không | 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 | Không | — |
default_currency | string | Có | — |
default_payment_terms_days | integer | Không | — |
default_footer | string | Không | — |
default_notes | string | Không | — |
number_prefix | string | Có | — |
number_padding | integer | Không | — |
next_number | integer | Có | 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 | Không | What the next invoice will be called, e.g. `INV-0042`. |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 404 · 422 · 429