agency-invoicing
GET /v1/agency-invoicing/profile
Your agency's invoicing identity — what an invoice says it is FROM.
Баталгаажуулалт
API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Түлхүүр нь agency.invoicing.view эрхтэй байх ёстой бөгөөд үүнгүйгээр 404 биш, харин 403 алдаа буцааж татгалзах болно.
Таны байгууллагын дугаар орох газар
Энэ төгсгөл цэг нь org_id-г асуулгын параметр болгон авдаг. Үүнийг орхивол дуудлага таны бүх түрээсийн дэд модыг хамрах бөгөөд дуудлагыг зөвхөн нэг байгууллагаар хязгаарлахын тулд үүнийг илгээнэ үү.
Танай байгууллагын ID нь таны хяналтын самбар дээрх API түлхүүрийн дэлгэцэнд, түлхүүр өөрөө хажууд байрладаг. Энэ нь таны хийх дуудлага бүрт ижил ID байна.
Туршиж үзэх
Өнцөг хаалтанд байгаа бүх зүйлийг өөрийн утгаар солиж, түлхүүр санамж байрлуулагчийг хяналтын самбарынхаа түлхүүрээр сольж оруулна уу.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/profile \
-H "Authorization: Bearer zdk_live_…"Та нэвтэрсэн байна уу? Таны хяналтын самбар дахь API консол нь таны бодит байгууллагын ID болон өөрийн түлхүүрийг автоматаар бөглөж, шууд ажиллаж буй API рүү хүсэлт илгээх тул та бодит хариуг харах боломжтой болно. Энэ төгсгөлийн цэгийг API консол дээр нээх
Дэлгэрэнгүй
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`.
Параметрүүд
| Нэр | Төрөл | Заавал шаардлагатай | Энэ юу вэ |
|---|---|---|---|
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 | Үгүй | 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 · 429