agency-invoicing

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

Edit a draft invoice.

ការផ្ទៀងផ្ទាត់ភាពត្រឹមត្រូវ

បញ្ជូនសោ API ជា bearer token។ សោនេះត្រូវតែមានសិទ្ធិ agency.invoicing.manage។ សោដែលគ្មានសិទ្ធិនេះនឹងត្រូវបដិសេធដោយកូដ 403 មិនមែន 404 ទេ។

កន្លែងដែលលេខសម្គាល់អង្គការរបស់អ្នកត្រូវដាក់

ចំណុចប្រទាក់នេះទទួលយក 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 ក្នុងផ្ទាំងគ្រប់គ្រងរបស់អ្នក បំពេញលេខសម្គាល់ស្ថាប័នពិតប្រាកដរបស់អ្នក និងសោផ្ទាល់ខ្លួនរបស់អ្នក ហើយដំណើរការសំណើទល់នឹង 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[]`	ទេ	—

ផ្អាកដំណើរការ

ឈ្មោះ	ប្រភេទ	តម្រូវការ	តើវាជាអ្វី
`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}