openapi: 3.0.2
info:
  title: Automated Spreading and Analysis Api-Key Requirements API
  version: 1.3.1
  description: "This [REST API](https://en.wikipedia.org/wiki/Representational_state_transfer) allows you to interact with the Automated Spreading processing and insights engine. \n\n# Authentication\n\nThis API uses API keys generated from a Automated Spreading User account. To get access to your User account, speak with your Automated Spreading account manager.\n\n# Accepted Media Types\n\n| File Type      | Extension(s)     | Content-Type(s) |\n| -------------------------------- |-------------- | ------------ |\n| PDF File | .pdf | `application/pdf` , `application/x-pdf` |\n| Excel File | .xls | `application/vnd.ms-excel`  |\n| Excel File | .xlsx | `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`  |\n| Excel File | .xlsm | `application/vnd.ms-excel.sheet.macroEnabled.12`  |\n| PNG Image | .png | `image/png`  |\n| GIF Image | .gif | `image/gif`  |\n| JPG Image | .jpg, .jpeg | `image/jpeg`  |\n| GIF Image | .gif | `image/gif`  |\n| JSON File | .json | `application/json`  |\n\n\n# Getting Started\n\n1. [Create a Borrower](#operation/createBorrower) \n2. [Add a file](#operation/createDocumentFile) for that Borrower.\n3. Analyze in the Automated Spreading App\n\n****"
  x-logo:
    url: https://manual-public-web-static-resources.s3.amazonaws.com/public-api/Moodys-icon.svg
  contact:
    name: Moody's Automated Spreading Customer Support
    email: MA_NMR_Support@moodys.com
security:
- API_Key: []
tags:
- name: Requirements
  description: Set rules/covenants for your borrowers
paths:
  /v1/financial-requirement:
    get:
      operationId: listFinancialRequirements
      description: List FinancialRequirement records
      parameters:
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: borrower_uuid
        required: false
        in: query
        description: Borrower to filter results for
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                required:
                - count
                - results
                properties:
                  count:
                    type: integer
                    example: 123
                  next:
                    type: string
                    nullable: true
                    format: uri
                    example: http://api.example.org/accounts/?offset=400&limit=100
                  previous:
                    type: string
                    nullable: true
                    format: uri
                    example: http://api.example.org/accounts/?offset=200&limit=100
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/FinancialRequirement'
          description: ''
      tags:
      - Requirements
      summary: List FinancialRequirements
    post:
      operationId: createFinancialRequirement
      description: Create a new FinancialRequirement record
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FinancialRequirement'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/FinancialRequirement'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FinancialRequirement'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialRequirement'
          description: ''
      tags:
      - Requirements
      summary: Create a new FinancialRequirement
  /v1/financial-requirement/{uuid}:
    get:
      operationId: retrieveFinancialRequirement
      description: Retrieve a FinancialRequirement
      parameters:
      - name: uuid
        in: path
        required: true
        description: ''
        schema:
          type: string
      - name: borrower_uuid
        required: false
        in: query
        description: Borrower to filter results for
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialRequirement'
          description: ''
      tags:
      - Requirements
      summary: Retrieve a FinancialRequirement
    patch:
      operationId: partialUpdateFinancialRequirement
      description: ''
      parameters:
      - name: uuid
        in: path
        required: true
        description: ''
        schema:
          type: string
      - name: borrower_uuid
        required: false
        in: query
        description: Borrower to filter results for
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FinancialRequirement'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/FinancialRequirement'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FinancialRequirement'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialRequirement'
          description: ''
      tags:
      - Requirements
      summary: Update a FinancialRequirement
components:
  schemas:
    FinancialRequirement:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          description: Title of the FinancialRequirement. Must be unique for the Borrower
          maxLength: 255
        description:
          type: string
          nullable: true
        created_date:
          type: string
          format: date-time
          readOnly: true
        external_id:
          type: string
          nullable: true
          description: External ID is used to uniquely identify a record from your system in our system. Must be unique across records.
          maxLength: 250
        borrower_uuid:
          type: string
          format: uuid
          description: UUID of the borrower for this loan. (see [Borrowers](#tag/Borrowers))
        loan_uuid:
          type: string
          format: uuid
          description: UUID of the loan for this requirement. (see [Loans](#tag/Loans))
        input_equation:
          type: string
          maxLength: 1200
        frequency:
          enum:
          - MONTHLY
          - QUARTERLY
          - SEMI_ANNUALLY
          - ANNUALLY
          - TTM
          - FISCAL_YTD
          type: string
        rules:
          type: array
          items:
            type: object
            properties:
              uuid:
                type: string
                format: uuid
                readOnly: true
              threshold_value:
                type: number
                multipleOf: 0.01
                maximum: 1000000000000000000
                minimum: -1000000000000000000
              comparer:
                enum:
                - ==
                - '!='
                - '>'
                - <
                - '>='
                - <=
                type: string
              start_date:
                type: string
                format: date
              end_date:
                type: string
                format: date
                nullable: true
            required:
            - threshold_value
            - start_date
      required:
      - name
      - borrower_uuid
      - input_equation
  securitySchemes:
    API_Key:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-tagGroups:
- name: Tenant
  tags:
  - Api-Key
  - TenantSettings
- name: Templates
  tags:
  - SpreadingTemplate
  - DscrTemplate
  - GlobalCashflowTemplate
- name: Borrower
  tags:
  - Borrowers
  - Files
  - Loans
  - Requirements
  - Portfolios
- name: Normalized Data
  tags:
  - DataViews
  - Templates
- name: Analysis
  tags:
  - DscrAnalysis
  - GlobalCashflowAnalysis
- name: Events
  tags:
  - Webhooks
- name: Embedded UI
  tags:
  - EmbeddedDocument
  - EmbeddedFinancials
  - EmbeddedDscrAnalysis
  - EmbeddedGlobalCashflowAnalysis