agency-invoicing

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

Edit a draft invoice.

සත්‍යාපනය

බෙරර් ටෝකනයක් ලෙස API යතුරක් යවන්න. යතුරෙහි agency.invoicing.manage අවසරය තිබිය යුතුය; එය නොමැති යතුරක් 404 ලෙස නොව 403 ලෙස ප්‍රතික්ෂේප කෙරේ.

ඔry ඔබේ සංවිධාන හැඳුනුම් අංකය (organisation id) ඇතුළත් කරන ස්ථානය

මෙම අවසාන ලක්ෂ්‍යය (endpoint) විමසුම් පරාමිතියක් ලෙස org_id ලබා ගනී. එය ඉවත් කළ විට ඇමතීම ඔබේ මුළු කුලී උප වෘක්ෂය (tenancy subtree) ආවරණය කරයි; ඇමතීම එක් සංවිධානයකට පමණක් සීමා කිරීමට එය යවන්න.

ඔබගේ සංවිධාන ID එක ඔබගේ පාලක පුවරුවේ ඇති API යතුරු තිරයේ, යතුරට ඊළඟින් දක්වා ඇත. ඔබ සිදු කරන සෑම ඇමතුමකදීම ඇත්තේ එම ID එකමය.

උත්සාහ කරන්න

<අගයන්> සමඟ කෝණික වරහන් තුළ ඇති ඕනෑම දෙයක් සහ ඔබේ උපකරණ පුවරුවෙන් ලබාගත් යතුරක් සමඟ key ස්ථාන දායකය ප්‍රතිස්ථාපනය කරන්න.

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

පද්ධතියට පිවිස සිටිනවාද? ඔබගේ උපකරණ පුවරුවේ ඇති API කොන්සෝලය මඟින් ඔබේ සැබෑ ආයතනික හැඳුනුම්පත සහ ඔබේම යතුර පුරවා, සජීවී API වෙත ඉල්ලීම ක්‍රියාත්මක කරන බැවින් ඔබට සැබෑ ප්‍රතිචාරය දැකගත හැක. මෙම අග්‍රලක්ෂ්‍යය 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[]`	නැත	—

පsspil

නම	වර්ගය	අත්‍යවශ්‍යයි	එය කුමක්ද
`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}