proposals
GET /v1/proposals/{proposalId}
One proposal, with its lines, live invoice and full audit trail.
Аутентификација
Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.
Где се уноси ID ваше организације
Ова крајња тачка прихвата org_id као параметар упита. Изоставите га и позив ће обухватити цело подстабло вашег закупа; пошаљите га да бисте сузили позив на једну организацију.
Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/proposals/{proposalId} \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
proposalId (path) | string | Да | — |
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… |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
id | string | Да | — |
reference | string | Да | — |
status | ProposalStatus | Да | — |
title | string | Да | — |
currency | string | Да | — |
recipient_name | string | Да | — |
recipient_email | string | Да | — |
recipient_company | string | Не | — |
revision | integer | Да | — |
valid_until | object | Не | — |
sent_at | object | Не | — |
decided_at | object | Не | — |
paid_at | object | Не | — |
board_id | object | Не | — |
created_at | string | Да | — |
updated_at | string | Не | — |
message | string | Не | — |
terms | string | Не | — |
agency_tax_rate_id | object | Не | — |
recipient_country | string | Не | — |
recipient_tax_id | string | Не | — |
recipient_locale | string | Не | — |
accepted_revision | object | Не | — |
accepted_by_name | string | Не | — |
source_request_id | object | Не | — |
completed_at | object | Не | — |
lines | ProposalLine[] | Да | — |
totals | ProposalTotals | Да | — |
invoice | ProposalInvoice | null | Не | — |
events | ProposalEvent[] | Да | — |
editable | boolean | Да | — |
public_url | string | Не | Returned ONCE, by send. Never readable again. |
Грешке које ова крајња тачка може вратити
401 · 403 · 404