agency-invoicing

PATCH /v1/agency-invoicing/profile

Change your invoicing identity or defaults.

Όλα τα τελικά σημεία agency-invoicing

Πισtoποίηση

Στείλτε ένα κλειδί API ως διακριτικό φορέα (bearer token). Το κλειδί πρέπει να διαθέτει το δικαίωμα agency.invoicing.manage· ένα κλειδί που δεν το διαθέτει απορρίπτεται με 403, όχι 404.

Πού μπαίνει το αναγνωριστικό του οργανισμού σας

Αυτό το τελικό σημείο δέχεται την παράμετρο org_id ως παράμετρο ερωτήματος. Παραλείψτε την και η κλήση καλύπτει ολόκληρο το υποδέντρο μίσθωσής σας· στείλτε την για να περιορίσετε την κλήση σε έναν οργανισμό.

Το αναγνωριστικό του οργανισμού σας βρίσκεται στην οθόνη των κλειδιών API στον πίνακα ελέγχου σας, δίπλα στο ίδιο το κλειδί. Είναι το ίδιο αναγνωριστικό σε κάθε κλήση που πραγματοποιείτε.

Δοκιμάστε το

Ατικatastήstε ό,τι βρίskεtai μέσα σe γώniaδeς μe τis δikές sas timές, kai to placeholder klεidioύ μe éna klεidi apó ton pinaka ελέgchou sas.

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`.

Παράμετροι

ΌνομαΤύpοςΥποχρεωτικόΤι είναι
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…

Σώμα αίτησης

ΌνομαΤύpοςΥποχρεωτικόΤι είναι
business_namestringΌχι
addressstringΌχι
emailstringΌχι
phonestringΌχι
websitestringΌχι
tax_number_labelstringΌχι
tax_numberstringΌχι
payment_instructionsstringΌχι
logo_sha256stringΌχι
accent_colourstringΌχι
default_currencystringΌχι
default_payment_terms_daysintegerΌχι
default_footerstringΌχι
default_notesstringΌχι
number_prefixstringΌχι
number_paddingintegerΌχι

Απάντηση

ΌνομαΤύpοςΥποχρεωτικόΤι είναι
business_namestringΌχι
addressstringΌχιThe registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema.
emailstringΌχι
phonestringΌχι
websitestringΌχι
tax_number_labelstringΌχι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_numberstringΌχι
payment_instructionsstringΌχι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_sha256stringΌχι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_colourstringΌχι
default_currencystringΝαι
default_payment_terms_daysintegerΌχι
default_footerstringΌχι
default_notesstringΌχι
number_prefixstringΝαι
number_paddingintegerΌχι
next_numberintegerΝαιThe next sequence number. ⛔ Read-only. Rewinding it would mint a duplicate number for a document already in a client's hands.
next_number_previewstringΌχιWhat the next invoice will be called, e.g. `INV-0042`.

Σφάλματα που μπορεί να επιστρέψει αυτό το τελικό σημείο

401 · 403 · 404 · 422 · 429