agency-invoicing

POST `/v1/agency-invoicing/invoices/{invoiceId}/payments`

Record money received — mark it paid or part-paid.

ದೃಢೀಕರಣ

ಬೇರರ್ ಟೋಕನ್ ಆಗಿ API ಕೀಯನ್ನು ಕಳುಹಿಸಿ. ಕೀಯು agency.invoicing.manage ಅನುಮತಿಯನ್ನು ಹೊಂದಿರಬೇಕು; ಅದನ್ನು ಹೊಂದಿರದ ಕೀಯನ್ನು 404 ಬದಲಿಗೆ 403 ನೊಂದಿಗೆ ತಿರಸ್ಕರಿಸಲಾಗುತ್ತದೆ.

ನಿಮ್ಮ ಸಂಸ್ಥೆಯ ಐಡಿ ಬರುವ ಸ್ಥಳ

ಈ ಎಂಡ್‌ಪಾಯಿಂಟ್ org_id ಅನ್ನು ಕ್ವೆರಿ ಪ್ಯಾರಾಮೀಟರ್ ಆಗಿ ತೆಗೆದುಕೊಳ್ಳುತ್ತದೆ. ಅದನ್ನು ಬಿಟ್ಟುಬಿಟ್ಟರೆ ಕರೆಯು ನಿಮ್ಮ ಸಂಪೂರ್ಣ ಟೆನೆನ್ಸಿ ಉಪಮರವನ್ನು (sub-tree) ಒಳಗೊಳ್ಳುತ್ತದೆ; ಕರೆಯನ್ನು ಒಂದೇ ಸಂಸ್ಥೆಗೆ ಸೀಮಿತಗೊಳಿಸಲು ಅದನ್ನು ಕಳುಹಿಸಿ.

ನಿಮ್ಮ ಸಂಸ್ಥೆಯ ಐಡಿಯು ನಿಮ್ಮ ಡ್ಯಾಶ್‌ಬೋರ್ಡ್‌ನಲ್ಲಿರುವ API ಕೀಗಳ ಪರದೆಯ ಮೇಲೆ, ಕೀ ಯ ಪಕ್ಕದಲ್ಲೇ ಇರುತ್ತದೆ. ನೀವು ಮಾಡುವ ಪ್ರತಿಯೊಂದು ಕರೆ(call)ಯಲ್ಲೂ ಇದು ಒಂದೇ ಐಡಿ ಆಗಿರುತ್ತದೆ.

ಪ್ರಯತ್ನಿಸಿ

ಕೋನೀಯ ಬ್ರಾಕೆಟ್‌ಗಳಲ್ಲಿರುವ ಯಾವುದೇ ಅಂಶವನ್ನು ನಿಮ್ಮ ಸ್ವಂತ ಮೌಲ್ಯಗಳೊಂದಿಗೆ ಮತ್ತು ಕೀ ಪ್ಲೇಸ್‌ಹೋಲ್ಡರ್ ಅನ್ನು ನಿಮ್ಮ ಡ್ಯಾಶ್‌ಬೋರ್ಡ್‌ನಲ್ಲಿರುವ ಕೀಯೊಂದಿಗೆ ಬದಲಾಯಿಸಿ.

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

ಸೈನ್ ಇನ್ ಆಗಿದ್ದೀರಾ? ನಿಮ್ಮ ಡ್ಯಾಶ್‌ಬೋರ್ಡ್‌ನಲ್ಲಿರುವ API ಕನ್ಸೋಲ್ ನಿಮ್ಮ ನೈಜ ಸಂಸ್ಥೆಯ ID ಮತ್ತು ನಿಮ್ಮ ಸ್ವಂತ ಕೀಲಿಯನ್ನು ಭರ್ತಿ ಮಾಡುತ್ತದೆ, ಮತ್ತು ಲೈವ್ API ವಿರುದ್ಧ ವಿನಂತಿಯನ್ನು ರನ್ ಮಾಡುತ್ತದೆ ಆದ್ದರಿಂದ ನೀವು ನಿಜವಾದ ಪ್ರತಿಕ್ರಿಯೆಯನ್ನು ನೋಡಬಹುದು. API ಕನ್ಸೋಲ್‌ನಲ್ಲಿ ಈ ಎಂಡ್‌ಪಾಯಿಂಟ್ ತೆರೆಯಿರಿ

ವಿವರಗಳು

Defaults to the outstanding balance. The invoice's status is re-derived from the SUM of its payment rows, never incremented, so the two can never disagree. 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…

ಅನ್ವಯದ ದೇಹ

ಹೆಸರು	ಪ್ರಕಾರ	ಅಗತ್ಯವಿದೆ	ಏನಿದು
`amount_minor`	`integer`	ಇಲ್ಲ	Defaults to the outstanding balance.
`method`	`string<card, wallet, crypto, bank_transfer, cash, cheque, other>`	ಇಲ್ಲ	—
`note`	`string`	ಇಲ್ಲ	—

ಪ್ರತಿಕ್ರಿಯೆ

ಹೆಸರು	ಪ್ರಕಾರ	ಅಗತ್ಯವಿದೆ	ಏನಿದು
`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 · 422 · 429

POST /v1/agency-invoicing/invoices/{invoiceId}/payments