പ്രമാണീകരണം
ബെയറർ ടോക്കണായി ഒരു API കീ അയയ്ക്കുക. കീക്ക് billing.view അനുമതി ഉണ്ടായിരിക്കണം; അനുമതിയില്ലാത്ത കീ 404 അല്ല, 403 നൽകി നിരസിക്കപ്പെടും.
നിങ്ങളുടെ ഓർഗനൈസേഷൻ ഐഡി നൽകേണ്ട ഇടം
ഈ എൻഡ്പോയിന്റ് org_id എന്നത് ഒരു ക്വറി പരാമീറ്ററായി സ്വീകരിക്കുന്നു. ഇത് ഒഴിവാക്കിയാൽ കോൾ നിങ്ങളുടെ മുഴുവൻ ടെനൻസി സബ്ട്രീയെയും ഉൾക്കൊള്ളുന്നു; കോൾ ഒരു സ്ഥാപനത്തിലേക്ക് മാത്രമായി ചുരുക്കാൻ ഇത് അയക്കുക.
നിങ്ങളുടെ ഡാഷ്ബോർഡിലെ API കീകൾക്കായുള്ള സ്ക്രീനിൽ കീയ്ക്ക് തൊട്ടടുത്തായി നിങ്ങളുടെ ഓർഗനൈസേഷൻ ഐഡി ലഭ്യമാണ്. നിങ്ങൾ നടത്തുന്ന എല്ലാ കോളുകളിലും ഉപയോഗിക്കുന്നത് ഒരേ ഐഡി തന്നെയാണ്.
ശ്രമിച്ച് നോക്കൂ
കോണമ്ബ്രക്കറ്റുകളിലുള്ള ഏതും നിങ്ങളുടെ സ്വന്തം മൂല്യങ്ങൾ ഉപയോഗിച്ച് മാറ്റിസ്ഥാപിക്കുക, കീ പ്ലേസ്ഹോൾഡർ നിങ്ങളുടെ ഡാഷ്ബോർഡിലെ ഒരു കീ ഉപയോഗിച്ചും മാറ്റിസ്ഥാപിക്കുക.
curl -X GET https://api.zinndigital.com/v1/invoices \
-H "Authorization: Bearer zdk_live_…"സൈൻ ഇൻ ചെയ്തിട്ടുണ്ടോ? നിങ്ങളുടെ ഡാഷ്ബോർഡിലെ API കൺസോൾ നിങ്ങളുടെ യഥാർത്ഥ ഓർഗനൈസേഷൻ ഐഡിയും നിങ്ങളുടെ സ്വന്തം കീയും പൂരിപ്പിക്കുകയും, യഥാർത്ഥ പ്രതികരണം (response) നിങ്ങൾക്ക് കാണുന്നതിനായി ലൈവ് API-ലേക്ക് അഭ്യർത്ഥന (request) പ്രവർത്തിപ്പിക്കുകയും ചെയ്യുന്നു. ഈ എൻഡ്പോയിന്റ് API കൺസോളിൽ തുറക്കുക
വിശദാംശങ്ങൾ
The organization's billing history — every invoice and credit note issued to it, newest first, with its lines, its payment summaries and the captured amounts. Cursor-paginated, filterable by status; RLS-scoped; requires billing.view. These are the real legal documents (docs/34 §1). Each is an immutable snapshot with a gapless, per-entity ZD-INV-YYYY-NNNNNN number, a captured tax treatment and its own frozen FX rates. document_type separates an invoice from a credit note; credits_invoice_id says which invoice a credit note un-bills. ⚠️ The document is issued by a sweep, a couple of minutes after payment, not synchronously at checkout (docs/34 §4.1). Render a pending state for a just-placed order rather than assuming the document is there the moment checkout returns. pdf_url stays null until PDF rendering lands (#708).
പരാമീറ്ററുകൾ
| പേര് | തരം | ആവശ്യമാണ് | എന്താണിത് |
|---|---|---|---|
X-Zinn-Org (header) | string | ഇല്ല | Which organisation this call acts for. Send a client organisation's id and every org-scoped endpoint answers for that client alone; omit it and the answer covers everything… |
cursor (query) | string | ഇല്ല | Opaque cursor from a previous page's page.next_cursor. |
limit (query) | integer | ഇല്ല | Maximum items to return (page size). |
status (query) | InvoiceStatus | ഇല്ല | Filter by billing-document status. |
org_id (query) | Uuid | ഇല്ല | Restrict to one organization in scope. |
പ്രതികരണം
| പേര് | തരം | ആവശ്യമാണ് | എന്താണിത് |
|---|---|---|---|
data | Invoice[] | അതെ | — |
page | PageMeta | അതെ | — |
ഈ എൻഡ്പോയിന്റ് നൽകാൻ കഴിയുന്ന പിഴവുകൾ
401 · 403 · 422 · 429