API 参考

proposals

该区域中有 16 个端点。每个端点都有自己的页面,其中包含其参数、响应以及您可以运行的请求。

所有开发者文档 →

方法路径功能说明权限
GET/v1/proposalsThe proposals this organisation has written — draft, sent, accepted and running.agency.invoicing.view
POST/v1/proposalsDraft a proposal. Nothing is sent until send.agency.invoicing.manage
GET/v1/proposals/{proposalId}One proposal, with its lines, live invoice and full audit trail.agency.invoicing.view
PATCH/v1/proposals/{proposalId}Edit a proposal before it is accepted.agency.invoicing.manage
POST/v1/proposals/{proposalId}/completeMark the project finished. The room stays readable.agency.invoicing.manage
POST/v1/proposals/{proposalId}/resend-linkReplace the recipient's link and e-mail the new one.agency.invoicing.manage
POST/v1/proposals/{proposalId}/sendIssue the current edits as a new revision and e-mail the recipient a fresh link.agency.invoicing.manage
POST/v1/proposals/{proposalId}/withdrawTake back a proposal that has not been accepted.agency.invoicing.manage
GET/v1/public/proposal-labelsThe proposal page's labels in one language, with no proposal. Unauthenticated.无 API 密钥
GET/v1/public/proposals/{token}The recipient's page — the document, its invoice and the project room. Unauthenticated.无 API 密钥
POST/v1/public/proposals/{token}/acceptAccept the newest revision. Raises its invoice in the same transaction.无 API 密钥
POST/v1/public/proposals/{token}/changesAsk the sender for an amended proposal.无 API 密钥
POST/v1/public/proposals/{token}/declineDecline the proposal, optionally saying why.无 API 密钥
POST/v1/public/proposals/{token}/filesShare a file into the project. Scanned before anyone can download it.无 API 密钥
GET/v1/public/proposals/{token}/files/{attachmentId}Download a shared file — only once its virus scan has passed.无 API 密钥
POST/v1/public/proposals/{token}/messagesPost a message into the project thread. Visible to both parties.无 API 密钥