Tài liệu tham khảo API
proposals
Có 16 điểm cuối trong khu vực này. Mỗi điểm cuối có một trang riêng với các tham số, phản hồi và yêu cầu mà quý vị có thể thực hiện.
| Phương thức | Đường dẫn | Chức năng | Quyền |
|---|---|---|---|
| GET | /v1/proposals | The proposals this organisation has written — draft, sent, accepted and running. | agency.invoicing.view |
| POST | /v1/proposals | Draft 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}/complete | Mark the project finished. The room stays readable. | agency.invoicing.manage |
| POST | /v1/proposals/{proposalId}/resend-link | Replace the recipient's link and e-mail the new one. | agency.invoicing.manage |
| POST | /v1/proposals/{proposalId}/send | Issue the current edits as a new revision and e-mail the recipient a fresh link. | agency.invoicing.manage |
| POST | /v1/proposals/{proposalId}/withdraw | Take back a proposal that has not been accepted. | agency.invoicing.manage |
| GET | /v1/public/proposal-labels | The proposal page's labels in one language, with no proposal. Unauthenticated. | Không có khóa API |
| GET | /v1/public/proposals/{token} | The recipient's page — the document, its invoice and the project room. Unauthenticated. | Không có khóa API |
| POST | /v1/public/proposals/{token}/accept | Accept the newest revision. Raises its invoice in the same transaction. | Không có khóa API |
| POST | /v1/public/proposals/{token}/changes | Ask the sender for an amended proposal. | Không có khóa API |
| POST | /v1/public/proposals/{token}/decline | Decline the proposal, optionally saying why. | Không có khóa API |
| POST | /v1/public/proposals/{token}/files | Share a file into the project. Scanned before anyone can download it. | Không có khóa API |
| GET | /v1/public/proposals/{token}/files/{attachmentId} | Download a shared file — only once its virus scan has passed. | Không có khóa API |
| POST | /v1/public/proposals/{token}/messages | Post a message into the project thread. Visible to both parties. | Không có khóa API |