agency-time

POST /v1/agency/time/projects/from-quote

Start a project from a free-quote request.

همه نقاط پایانی agency-time

همهٔ مستندات توسعه‌دهندگان

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز agency.time.manage باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد می‌شود، نه 404.

جایی که شناسه سازمان شما قرار می‌گیرد

این نقطه پایانی org_id را به عنوان یک فیلد در بدنه JSON دریافت می‌کند.

شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواست‌هایی که ارسال می‌کنید یکسان است.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

curl -X POST https://api.zinndigital.com/v1/agency/time/projects/from-quote \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "quote_id": <string> }'

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

جزئیات

Zinn Digital®'s own organisation only (docs/670 §2). In one transaction: the requester becomes a client (found by e-mail, or created, carrying the request's country), a project board is opened with the brief, a time project is linked to both in the quoted currency, the quoted price becomes a fixed-price task, and the request is marked won — which is what stops the admin queue's charge conversion and the draft-from-quote invoice billing the same job again. Requires agency.time.manage in the organisation and the quotes.manage staff permission the admin queue requires. Idempotent per request: a second call returns the project the first one made, with created: false.

بدنه درخواست

نامنوعالزامیچیست
quote_idstringبله
amount_minorintegerخیرThe agreed price, NET, in minor units — only for a request that has not been priced. On a priced request omit it; a different figure is refused.
currencystringخیر
countrystringخیرThe client's ISO-2 country, used only when the request carries none (the public form does not ask). The bill on the checkout needs it; anything but two letters is refused.
org_idstringخیر

پاسخ

نامنوعالزامیچیست
projectTimeProjectبله
board_idstringبله
client_idstringبله
createdbooleanبلهFALSE when a project for this request already existed and was returned.
price_already_billed_onstringخیرThe reference of a bill already drafted straight from this request, when there was one — in which case the project carries no fixed price, because that bill charges it.

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 422