Sanggunian ng API
proposals
16 mga endpoint sa lugar na ito. Ang bawat isa ay may sariling pahina kasama ang mga parameter nito, ang tugon nito, at isang kahilingan na maaari ninyong patakbuhin.
| Paraan | Path | Ang ginagawa nito | Pahintulot |
|---|---|---|---|
| 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. | Walang API key |
| GET | /v1/public/proposals/{token} | The recipient's page — the document, its invoice and the project room. Unauthenticated. | Walang API key |
| POST | /v1/public/proposals/{token}/accept | Accept the newest revision. Raises its invoice in the same transaction. | Walang API key |
| POST | /v1/public/proposals/{token}/changes | Ask the sender for an amended proposal. | Walang API key |
| POST | /v1/public/proposals/{token}/decline | Decline the proposal, optionally saying why. | Walang API key |
| POST | /v1/public/proposals/{token}/files | Share a file into the project. Scanned before anyone can download it. | Walang API key |
| GET | /v1/public/proposals/{token}/files/{attachmentId} | Download a shared file — only once its virus scan has passed. | Walang API key |
| POST | /v1/public/proposals/{token}/messages | Post a message into the project thread. Visible to both parties. | Walang API key |