agency-invoicing
PATCH /v1/agency-invoicing/profile
Change your invoicing identity or defaults.
ავტორიზაცია
API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს agency.invoicing.manage ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.
სwhere your organisation id goes-ის ადგილი
ეს ენდპოინტი იყენებს პარამეტრად org_id. მისი გამოტოვების შემთხვევაში ზარი ფარავს თქვენი იჯარის მთელ ქვეხეს, ხოლო გაგზავნისას ზარი შეიზღუდება მხოლოდ ერთ ორგანიზაციამდე.
თქვენი ორგანიზაციის ID მითითებულია თქვენი სამართავი პანელის API გასაღებების ეკრანზე, თავად გასაღებთან ახლოს. ის ერთნაირია თქვენ მიერ განხორციელებულ ყველა გამოძახებაში.
სცადეთ
შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.
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-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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