LawVu ContractKeyDate API

The ContractKeyDate API from LawVu — 1 operation(s) for contractkeydate.

OpenAPI Specification

lawvu-contractkeydate-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: LawVu Account Auth ContractKeyDate API
  description: Apis for account related resources (authentication, profiles, organisation details etc)
  version: '1.0'
servers:
- url: https://api-sandbox.lawvu.com/account-apis
  description: Sandbox API
- url: https://api.lawvu.com/account-apis
  description: Production API
tags:
- name: ContractKeyDate
paths:
  /v1/contracts/{contractId}/keyDates:
    get:
      tags:
      - ContractKeyDate
      summary: Get contract key dates
      description: Returns a list of contract key dates
      operationId: get-v1-contracts-contractid-keydates
      parameters:
      - name: contractId
        in: path
        description: The contract id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ContractKeyDateModelArray'
              example:
              - id: 1
                date: '2020-01-01'
                name: Key date 1
                value: 1
              - id: 2
                date: '2020-01-02'
                name: Key date 2
                value: 2
            application/json:
              schema:
                $ref: '#/components/schemas/ContractKeyDateModelArray'
              example:
              - id: 1
                date: '2020-01-01'
                name: Key date 1
                value: 1
              - id: 2
                date: '2020-01-02'
                name: Key date 2
                value: 2
            text/json:
              schema:
                $ref: '#/components/schemas/ContractKeyDateModelArray'
              example:
              - id: 1
                date: '2020-01-01'
                name: Key date 1
                value: 1
              - id: 2
                date: '2020-01-02'
                name: Key date 2
                value: 2
components:
  schemas:
    ContractKeyDateModelArray:
      type: array
      items:
        $ref: '#/components/schemas/ContractKeyDateModel'
    ContractKeyDateModel:
      type: object
      properties:
        id:
          type: integer
          format: int32
        date:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
        value:
          type: number
          format: double
      additionalProperties: false