Sales
Contracts
A contract holds the terms of one proposal: dates, payment notes, CC emails and where your client goes after answering. Each proposal has at most one contract, and it needs one before you can send it.
A contract is of its proposal's mode: a test key reads and writes only the contracts of its own sandbox proposals, and can't write one for a live proposal (404). Reading or changing your contract of the other mode answers 404 with the message No such contract: a similar object exists in live mode, but a test mode key was used to make this request. (or the reverse with a live key).
A contract is the terms your client accepts by clicking accept on a proposal. To get a document e-signed, use Agreements: a sealed e-signature document with an audit trail and a certificate.
Where a contract fits
What the fields do
Dates
When your client accepts, the project takes the contract's startDate and endDate, and the invoice is due 10 days after startDate.
CC emails
When you send the proposal, each address in ccEmail gets a view-only link. CC recipients can read the proposal but can't accept or reject it.
After your client answers
redirectUrl is where your client goes after accepting or rejecting. Without it, they go to the Vezmo website.
Notes for your records
status, message, paymentMethod, paymentDue, isPartialPay and expiryRule are kept with the contract. Vezmo doesn't act on them; nothing expires on its own.
Deleting
Delete moves a contract to trash and out of your list; Restore contract brings it back. A deleted contract still belongs to its proposal, so that proposal can't take a new one.
Permissions
Each route needs one scope on your API key:
contract.read: List and Getcontract.create: Createcontract.update: Updatecontract.delete: Deletecontract.restore: Restore