agency-invoicing
GET /v1/agency-invoicing/profile
Your agency's invoicing identity — what an invoice says it is FROM.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie agency.invoicing.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Miejsce na identyfikator organizacji
Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.
Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/profile \
-H "Authorization: Bearer zdk_live_…"Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
Your registered name, address, tax number, logo, brand colour, defaults and your OWN invoice number series. ⛔ Separate from your panel branding: an invoice needs a legal entity, and you may bill under a different one from the one on your dashboard. Requires `agency.invoicing.view`.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
org_id (query) | Uuid | Nie | 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… |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
business_name | string | Nie | — |
address | string | Nie | The registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema. |
email | string | Nie | — |
phone | string | Nie | — |
website | string | Nie | — |
tax_number_label | string | Nie | 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 | Nie | — |
payment_instructions | string | Nie | 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 | Nie | 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 | Nie | — |
default_currency | string | Tak | — |
default_payment_terms_days | integer | Nie | — |
default_footer | string | Nie | — |
default_notes | string | Nie | — |
number_prefix | string | Tak | — |
number_padding | integer | Nie | — |
next_number | integer | Tak | 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 | Nie | What the next invoice will be called, e.g. `INV-0042`. |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404 · 429