contracts
Create a new contract
post/api/v1/documents/contracts
Headers
x-api-keystring nullable
Request body
contractorEmailstring nullable
clientEmailstring nullable
labelstring nullable
type'service' | 'employment' | 'nda' | 'contractor' | 'default_contractor' | 'custom' | 'vendor' | 'milestone' | 'msa' | 'other'
Contract type.
period'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly'
Recurring billing period of a contract.
activationAtstring date-time nullable
expirationAtstring date-time nullable
status'pending_approval_by_contractor' | 'pending_approval_by_client' | 'active' | 'completed' | 'cancelled' | 'paused'
Contract status.
fieldsobject nullable
documentIdstring uuid nullable
priorityMethodsTransactionType[]
paymentMethodsobject[]
requireClientKycboolean
requireClientW89boolean
requireContractorKycboolean
requireContractorW89boolean
Response
Successful Response
idstring uuid required
clientIdstring uuid required
contractorIdstring uuid required
labelstring nullable
documentIdstring uuid nullable
documentNamestring nullable
documentFileNamestring nullable
documentDownloadLinkstring nullable
type'service' | 'employment' | 'nda' | 'contractor' | 'default_contractor' | 'custom' | 'vendor' | 'milestone' | 'msa' | 'other' required
Contract type.
status'pending_approval_by_contractor' | 'pending_approval_by_client' | 'active' | 'completed' | 'cancelled' | 'paused' required
Contract status.
amountstring nullable
currency'USD' | 'EUR' | 'GBP' | 'JPY' | 'CHF' | 'CAD' | 'AUD' | 'NZD' | 'SEK' | 'NOK' | 'AED' | 'HKD'
Supported invoice/contract currencies. G10 majors + AED/HKD.
periodstring nullable
activationAtstring date-time nullable
expirationAtstring date-time nullable
signatureRequestIdstring nullable
signedobject nullable
clientAcceptanceobject nullable
contractorAcceptanceobject nullable
creatorIdstring uuid nullable
fieldsobject nullable
priorityMethodsTransactionType[]
paymentMethodsobject[]
createdAtstring date-time required
updatedAtstring date-time required