agency-invoicing
PATCH /v1/agency-invoicing/profile
Change your invoicing identity or defaults.
પ્રમાણીકરણ
એપીઆઈ કી (API key) ને બેરર ટોકન તરીકે મોકલો. કી પાસે 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`.
પેરામીટર્સ
| નામ | પ્રકાર | જરૂરી | તે શું છે |
|---|---|---|---|
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