agency-invoicing
PATCH /v1/agency-invoicing/profile
Change your invoicing identity or defaults.
പ്രമാണീകരണം
ബെയറർ ടോക്കണായി ഒരു API കീ അയയ്ക്കുക. കീക്ക് 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 കൺസോൾ നിങ്ങളുടെ യഥാർത്ഥ ഓർഗനൈസേഷൻ ഐഡിയും നിങ്ങളുടെ സ്വന്തം കീയും പൂരിപ്പിക്കുകയും, യഥാർത്ഥ പ്രതികരണം (response) നിങ്ങൾക്ക് കാണുന്നതിനായി ലൈവ് API-ലേക്ക് അഭ്യർത്ഥന (request) പ്രവർത്തിപ്പിക്കുകയും ചെയ്യുന്നു. ഈ എൻഡ്പോയിന്റ് 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