> ## Documentation Index
> Fetch the complete documentation index at: https://hevninc.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Preview contract document generated from a saved contract



## OpenAPI

````yaml /openapi.json get /api/v1/documents/contracts/{contract_id}/preview
openapi: 3.1.0
info:
  title: HEVN API
  description: Backend API for HEVN mobile neobank
  version: 0.1.2
servers:
  - url: https://api.hevn.finance
    description: Production
security: []
paths:
  /api/v1/documents/contracts/{contract_id}/preview:
    get:
      tags:
        - contracts
      summary: Preview contract document generated from a saved contract
      operationId: >-
        preview_contract_document_api_v1_documents_contracts__contract_id__preview_get
      parameters:
        - name: contract_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Contract Id
        - name: x-api-key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateContractDocumentResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    GenerateContractDocumentResponse:
      properties:
        type:
          $ref: '#/components/schemas/ContractDocumentTemplateType'
        markdown:
          type: string
          title: Markdown
        html:
          type: string
          title: Html
        htmlPreview:
          anyOf:
            - type: string
            - type: 'null'
          title: Htmlpreview
        fields:
          anyOf:
            - $ref: '#/components/schemas/EmployerContractPreviewFields'
            - $ref: '#/components/schemas/ServiceContractPreviewFields'
            - $ref: '#/components/schemas/ContractorContractPreviewFields'
            - $ref: '#/components/schemas/CustomContractPreviewFields'
            - type: 'null'
          title: Fields
        missingFields:
          items:
            type: string
          type: array
          title: Missingfields
      type: object
      required:
        - type
        - markdown
        - html
      title: GenerateContractDocumentResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ContractDocumentTemplateType:
      type: string
      enum:
        - employer
        - employment
        - service
        - contractor
        - default_contractor
        - custom
        - nda
        - vendor
        - milestone
        - msa
      title: ContractDocumentTemplateType
      description: Markdown contract template type.
    EmployerContractPreviewFields:
      properties:
        effectiveDate:
          type: string
          title: Effectivedate
        employerName:
          type: string
          title: Employername
        employeeName:
          type: string
          title: Employeename
        positionTitle:
          type: string
          title: Positiontitle
        startDate:
          type: string
          title: Startdate
        endDate:
          type: string
          title: Enddate
        scope:
          type: string
          title: Scope
        compensation:
          type: string
          title: Compensation
        paymentTerms:
          type: string
          title: Paymentterms
        invoiceCycle:
          type: string
          title: Invoicecycle
        paymentDue:
          type: string
          title: Paymentdue
        confidentialityTerms:
          type: string
          title: Confidentialityterms
        intellectualPropertyTerms:
          type: string
          title: Intellectualpropertyterms
        complianceTerms:
          type: string
          title: Complianceterms
      type: object
      required:
        - effectiveDate
        - employerName
        - employeeName
        - positionTitle
        - startDate
        - endDate
        - scope
        - compensation
        - paymentTerms
        - invoiceCycle
        - paymentDue
        - confidentialityTerms
        - intellectualPropertyTerms
        - complianceTerms
      title: EmployerContractPreviewFields
    ServiceContractPreviewFields:
      properties:
        effectiveDate:
          type: string
          title: Effectivedate
        clientName:
          type: string
          title: Clientname
        serviceProviderName:
          type: string
          title: Serviceprovidername
        services:
          type: string
          title: Services
        paymentTerms:
          type: string
          title: Paymentterms
        invoiceCycle:
          type: string
          title: Invoicecycle
        paymentDue:
          type: string
          title: Paymentdue
        confidentialityTerms:
          type: string
          title: Confidentialityterms
        intellectualPropertyTerms:
          type: string
          title: Intellectualpropertyterms
      type: object
      required:
        - effectiveDate
        - clientName
        - serviceProviderName
        - services
        - paymentTerms
        - invoiceCycle
        - paymentDue
        - confidentialityTerms
        - intellectualPropertyTerms
      title: ServiceContractPreviewFields
    ContractorContractPreviewFields:
      properties:
        effectiveDate:
          type: string
          title: Effectivedate
        clientName:
          type: string
          title: Clientname
        clientEntityType:
          type: string
          title: Cliententitytype
        clientAddress:
          type: string
          title: Clientaddress
        clientEmail:
          type: string
          title: Clientemail
        clientJurisdiction:
          anyOf:
            - type: string
            - type: 'null'
          title: Clientjurisdiction
        clientRegistrationNumber:
          anyOf:
            - type: string
            - type: 'null'
          title: Clientregistrationnumber
        contractorName:
          type: string
          title: Contractorname
        contractorEntityType:
          type: string
          title: Contractorentitytype
        contractorAddress:
          type: string
          title: Contractoraddress
        contractorEmail:
          type: string
          title: Contractoremail
        contractorJurisdiction:
          anyOf:
            - type: string
            - type: 'null'
          title: Contractorjurisdiction
        contractorRegistrationNumber:
          anyOf:
            - type: string
            - type: 'null'
          title: Contractorregistrationnumber
        governingLaw:
          type: string
          title: Governinglaw
        clientSignerName:
          type: string
          title: Clientsignername
        contractorSignerName:
          type: string
          title: Contractorsignername
        clientSignatureDate:
          type: string
          title: Clientsignaturedate
        contractorSignatureDate:
          type: string
          title: Contractorsignaturedate
      type: object
      required:
        - effectiveDate
        - clientName
        - clientEntityType
        - clientAddress
        - clientEmail
        - contractorName
        - contractorEntityType
        - contractorAddress
        - contractorEmail
        - governingLaw
        - clientSignerName
        - contractorSignerName
        - clientSignatureDate
        - contractorSignatureDate
      title: ContractorContractPreviewFields
    CustomContractPreviewFields:
      properties:
        items:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Items
      type: object
      title: CustomContractPreviewFields
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
      x-default: Bearer <token>

````