proposals
POST /v1/proposals
Draft a proposal. Nothing is sent until send.
Authentication
Send an API key as a bearer token. The key must carry the agency.invoicing.manage permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/proposals \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Requires agency.invoicing.manage. The recipient may be ANY e-mail address — they need no account. Every price is integer minor units (§2.8); a decimal is a 422.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | Uuid | No | 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… |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
title | string | No | — |
message | string | No | — |
terms | string | No | — |
currency | string | No | — |
valid_until | object | No | — |
agency_tax_rate_id | object | No | — |
recipient_name | string | No | — |
recipient_email | string | No | — |
recipient_company | string | No | — |
recipient_country | string | No | — |
recipient_tax_id | string | No | — |
recipient_locale | string | No | — |
source_request_id | object | No | — |
lines | ProposalLineInput[] | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
reference | string | Yes | — |
status | ProposalStatus | Yes | — |
title | string | Yes | — |
currency | string | Yes | — |
recipient_name | string | Yes | — |
recipient_email | string | Yes | — |
recipient_company | string | No | — |
revision | integer | Yes | — |
valid_until | object | No | — |
sent_at | object | No | — |
decided_at | object | No | — |
paid_at | object | No | — |
board_id | object | No | — |
created_at | string | Yes | — |
updated_at | string | No | — |
message | string | No | — |
terms | string | No | — |
agency_tax_rate_id | object | No | — |
recipient_country | string | No | — |
recipient_tax_id | string | No | — |
recipient_locale | string | No | — |
accepted_revision | object | No | — |
accepted_by_name | string | No | — |
source_request_id | object | No | — |
completed_at | object | No | — |
lines | ProposalLine[] | Yes | — |
totals | ProposalTotals | Yes | — |
invoice | ProposalInvoice | null | No | — |
events | ProposalEvent[] | Yes | — |
editable | boolean | Yes | — |
public_url | string | No | Returned ONCE, by send. Never readable again. |
Errors this endpoint can return
401 · 403 · 422