agency-invoicing

PATCH `/v1/agency-invoicing/invoices/{invoiceId}`

Edit a draft invoice.

എല്ലാ agency-invoicing എൻഡ്‌പോയിന്റുകളും

പ്രമാണീകരണം

ബെയറർ ടോക്കണായി ഒരു API കീ അയയ്ക്കുക. കീക്ക് agency.invoicing.manage അനുമതി ഉണ്ടായിരിക്കണം; അനുമതിയില്ലാത്ത കീ 404 അല്ല, 403 നൽകി നിരസിക്കപ്പെടും.

നിങ്ങളുടെ ഓർഗനൈസേഷൻ ഐഡി നൽകേണ്ട ഇടം

ഈ എൻഡ്‌പോയിന്റ് org_id എന്നത് ഒരു ക്വറി പരാമീറ്ററായി സ്വീകരിക്കുന്നു. ഇത് ഒഴിവാക്കിയാൽ കോൾ നിങ്ങളുടെ മുഴുവൻ ടെനൻസി സബ്‌ട്രീയെയും ഉൾക്കൊള്ളുന്നു; കോൾ ഒരു സ്ഥാപനത്തിലേക്ക് മാത്രമായി ചുരുക്കാൻ ഇത് അയക്കുക.

നിങ്ങളുടെ ഡാഷ്‌ബോർഡിലെ API കീകൾക്കായുള്ള സ്ക്രീനിൽ കീയ്ക്ക് തൊട്ടടുത്തായി നിങ്ങളുടെ ഓർഗനൈസേഷൻ ഐഡി ലഭ്യമാണ്. നിങ്ങൾ നടത്തുന്ന എല്ലാ കോളുകളിലും ഉപയോഗിക്കുന്നത് ഒരേ ഐഡി തന്നെയാണ്.

ശ്രമിച്ച് നോക്കൂ

കോണമ്ബ്രക്കറ്റുകളിലുള്ള ഏതും നിങ്ങളുടെ സ്വന്തം മൂല്യങ്ങൾ ഉപയോഗിച്ച് മാറ്റിസ്ഥാപിക്കുക, കീ പ്ലേസ്‌ഹോൾഡർ നിങ്ങളുടെ ഡാഷ്‌ബോർഡിലെ ഒരു കീ ഉപയോഗിച്ചും മാറ്റിസ്ഥാപിക്കുക.

curl -X PATCH https://api.zinndigital.com/v1/agency-invoicing/invoices/{invoiceId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

സൈൻ ഇൻ ചെയ്തിട്ടുണ്ടോ? നിങ്ങളുടെ ഡാഷ്‌ബോർഡിലെ API കൺസോൾ നിങ്ങളുടെ യഥാർത്ഥ ഓർഗനൈസേഷൻ ഐഡിയും നിങ്ങളുടെ സ്വന്തം കീയും പൂരിപ്പിക്കുകയും, യഥാർത്ഥ പ്രതികരണം (response) നിങ്ങൾക്ക് കാണുന്നതിനായി ലൈവ് API-ലേക്ക് അഭ്യർത്ഥന (request) പ്രവർത്തിപ്പിക്കുകയും ചെയ്യുന്നു. ഈ എൻഡ്പോയിന്റ് API കൺസോളിൽ തുറക്കുക

വിശദാംശങ്ങൾ

⛔ A `409` means the invoice has been issued and its figures are frozen. A sent invoice is a document your client is holding — void it and issue a replacement rather than restating it. Requires `agency.invoicing.manage`.

പരാമീറ്ററുകൾ

പേര്	തരം	ആവശ്യമാണ്	എന്താണിത്
`invoiceId (path)`	`Uuid`	അതെ	—
`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…

അഭ്യർത്ഥന ബോഡി

പേര്	തരം	ആവശ്യമാണ്	എന്താണിത്
`currency`	`string`	ഇല്ല	—
`issue_date`	`string`	ഇല്ല	—
`due_date`	`string`	ഇല്ല	—
`reference`	`string`	ഇല്ല	—
`notes`	`string`	ഇല്ല	—
`footer`	`string`	ഇല്ല	—
`lines`	`AgencyInvoiceLineWrite[]`	ഇല്ല	—

പ്രതികരണം

പേര്	തരം	ആവശ്യമാണ്	എന്താണിത്
`id`	`Uuid`	അതെ	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`number`	`string`	ഇല്ല	The agency's own number. ⛔ Empty until issue: a number allocated to something that may never be sent leaves a hole in a sequence.
`status`	`string<draft, sent, partially_paid, paid, void>`	അതെ	—
`is_overdue`	`boolean`	ഇല്ല	⭐ DERIVED from the due date and the status, never stored — so there is no sweep to maintain a flag and nothing to go stale. A draft is never overdue however old it is: nobody ha…
`client_id`	`Uuid`	ഇല്ല	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`client_name`	`string`	ഇല്ല	—
`currency`	`string`	അതെ	—
`issue_date`	`string`	അതെ	—
`due_date`	`string`	ഇല്ല	—
`reference`	`string`	ഇല്ല	—
`notes`	`string`	ഇല്ല	—
`footer`	`string`	ഇല്ല	—
`subtotal_minor`	`integer`	ഇല്ല	—
`discount_minor`	`integer`	ഇല്ല	—
`tax_minor`	`integer`	ഇല്ല	—
`total_minor`	`integer`	അതെ	—
`amount_paid_minor`	`integer`	ഇല്ല	—
`amount_due_minor`	`integer`	ഇല്ല	—
`tax_breakdown`	`AgencyInvoiceTaxGroup[]`	ഇല്ല	—
`source`	`string`	ഇല്ല	Where the invoice came from — `time_tracking` when it was generated from tracked hours, empty when an agency typed it.
`sent_at`	`string`	ഇല്ല	—
`last_sent_to`	`string`	ഇല്ല	—
`paid_at`	`string`	ഇല്ല	—
`void_reason`	`string`	ഇല്ല	—
`created_at`	`string`	ഇല്ല	—
`lines`	`AgencyInvoiceLine[]`	ഇല്ല	—
`payments`	`AgencyInvoicePayment[]`	ഇല്ല	—
`portal_url`	`string`	ഇല്ല	The payment link to send to the client. ⛔ Returned on a SINGLE-invoice read only, never in a list: a list is the thing that gets logged, cached and pasted into a support ticket,…

ഈ എൻഡ്‌പോയിന്റ് നൽകാൻ കഴിയുന്ന പിഴവുകൾ

401 · 403 · 404 · 409 · 422 · 429

PATCH /v1/agency-invoicing/invoices/{invoiceId}