agency-invoicing
PATCH /v1/agency-invoicing/profile
Change your invoicing identity or defaults.
Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Кілтте agency.invoicing.manage рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.
Ұйымыңыздың идентификаторы орналасатын жер
Бұл соңғы нүкте сұрау параметрі ретінде 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`.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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… |
Сұрау денесі
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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 | Жоқ | — |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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