Preview contract document generated from a saved contract

GET /api/v1/documents/contracts/{contract_id}/preview

Preview contract document generated from a saved contract

cURL

curl --request GET \
  --url https://api.hevn.finance/api/v1/documents/contracts/{contract_id}/preview \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.hevn.finance/api/v1/documents/contracts/{contract_id}/preview"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.hevn.finance/api/v1/documents/contracts/{contract_id}/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "markdown": "<string>",
  "html": "<string>",
  "htmlPreview": "<string>",
  "fields": {
    "effectiveDate": "<string>",
    "employerName": "<string>",
    "employeeName": "<string>",
    "positionTitle": "<string>",
    "startDate": "<string>",
    "endDate": "<string>",
    "scope": "<string>",
    "compensation": "<string>",
    "paymentTerms": "<string>",
    "invoiceCycle": "<string>",
    "paymentDue": "<string>",
    "confidentialityTerms": "<string>",
    "intellectualPropertyTerms": "<string>",
    "complianceTerms": "<string>"
  },
  "missingFields": [
    "<string>"
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · default: Bearer <token> · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key · string | null

Path Parameters

contract_id · string<uuid> · required

Response

200

application/json

Successful Response

type · enum<string> · required

Markdown contract template type.

Available options: employer, employment, service, contractor, default_contractor, custom, nda, vendor, milestone, msa

markdown · string · required

html · string · required

htmlPreview · string | null

fields · EmployerContractPreviewFields · object

EmployerContractPreviewFields

ServiceContractPreviewFields

ContractorContractPreviewFields

CustomContractPreviewFields

Show child attributes

missingFields · string[]