agency-invoicing
PATCH /v1/agency-invoicing/profile
Change your invoicing identity or defaults.
인증
Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 agency.invoicing.manage 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.
조직 ID가 들어가는 위치
이 엔드포인트는 org_id을(를) 쿼리 매개변수로 사용합니다. 생략하면 테넌트 하위 트리 전체가 호출 대상이 되며, 값을 전달하면 특정 조직으로 호출 범위를 좁힐 수 있습니다.
조직 ID는 대시보드의 API 키 화면에서 키 바로 옆에 있습니다. 이는 실행하는 모든 호출에서 동일한 ID입니다.
무료 체험하기
대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.
curl -X PATCH https://api.zinndigital.com/v1/agency-invoicing/profile \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 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