{
  "openapi": "3.0.4",
  "info": {
    "title": "Fenergo Nebula Financial Analysis Import Adapter Receptor",
    "description": "**Financial Analysis Import Adapter Receptor**:\n\n<br> Financial Analysis Import Adapter Receptor providers endpoint to recive adapter response.\n\n<br> **Financial Analysis Import Adapter Receptor Command API provides**:<br><ul><li> The ability to recive adapter response and call adapter handler.</li></ul>",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "/financialanalysisreceptor"
    }
  ],
  "paths": {
    "/api/receptor/callback": {
      "post": {
        "tags": [
          "Receptor"
        ],
        "summary": "Callback",
        "description": "\nThis method will handle adapters responses.\n            Processes Adapter Responses",
        "operationId": "Callback",
        "parameters": [
          {
            "name": "X-PROVIDER-ID",
            "in": "header",
            "description": "The ID of the provider",
            "schema": {
              "type": "string"
            },
            "example": "ProviderId"
          },
          {
            "name": "X-ENCRYPTION-IV",
            "in": "header",
            "description": "The encryption IV key, base64 encoded",
            "schema": {
              "type": "string"
            },
            "example": "HgyUHIO81m0FcZfPS1lnUw=="
          },
          {
            "name": "X-AUTHENTICATION-MAC",
            "in": "header",
            "description": "The authentication MAC key, base64 encoded",
            "schema": {
              "type": "string"
            },
            "example": "frr2J1pP5rUC6DLe8q1WNko7FmRqUOD8zYTQN4ABgiE="
          },
          {
            "name": "X-TENANT-ID",
            "in": "header",
            "description": "The UiD of the tenant representing organization",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "b11f8be3-f29b-4959-8964-956d4af7c468"
          }
        ],
        "requestBody": {
          "description": "Adapter response",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AdapterResponseDto"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/AdapterResponseDto"
              }
            },
            "application/*+json": {
              "schema": {
                "$ref": "#/components/schemas/AdapterResponseDto"
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Success. Data Accepted"
          },
          "400": {
            "description": "Bad request. The request has missing/invalid values",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error"
          },
          "401": {
            "description": "User is not authorized to perform this request",
            "content": {
              "application/json": {
                "example": {
                  "message": "Unauthorized"
                }
              }
            }
          },
          "403": {
            "description": "Access to resource is forbidden.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ObjectServiceResponse"
                },
                "example": {
                  "data": { },
                  "messages": [
                    {
                      "message": "Access denied. Following permissions are required: Permission1, Permission2",
                      "type": "Forbidden",
                      "errorCode": "Error Code"
                    }
                  ]
                }
              }
            }
          },
          "410": {
            "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StringServiceResponse"
                },
                "example": {
                  "data": null,
                  "messages": [
                    {
                      "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
                      "type": "Error",
                      "errorCode": "OBSOLETE_ENDPOINT"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "AdapterResponseDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": true
          },
          "tenant": {
            "type": "string",
            "nullable": true
          },
          "providerId": {
            "type": "string",
            "nullable": true
          },
          "requestType": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "completedOn": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "errorDetails": {
            "type": "string",
            "nullable": true
          },
          "errorCode": {
            "type": "string",
            "nullable": true
          },
          "response": {
            "type": "object",
            "additionalProperties": {
              "nullable": true
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ObjectServiceResponse": {
        "type": "object",
        "properties": {
          "data": {
            "nullable": true
          },
          "messages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceResponseMessage"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "detail": {
            "type": "string",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": { }
      },
      "ServiceResponseMessage": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "nullable": true
          },
          "type": {
            "type": "string",
            "nullable": true
          },
          "errorCode": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "StringServiceResponse": {
        "type": "object",
        "properties": {
          "data": {
            "type": "string",
            "nullable": true
          },
          "messages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceResponseMessage"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    }
  }
}