---
agentTools:
  projectIndex: https://docs.calqulate.io/llms.txt
---

# Financial Health

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Calqulate API",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.calqulate.io/v3"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-bearer-format": "bearer"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/financial-health": {
      "get": {
        "summary": "Financial Health",
        "description": "",
        "operationId": "financial-health-1",
        "parameters": [
          {
            "name": "Calqulate-Org-Id",
            "in": "header",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "financialHealthType",
            "in": "query",
            "description": "Select how you want to fetch your data as single value (index) or for chart (chart)",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "chart",
                "index"
              ]
            }
          },
          {
            "name": "start",
            "in": "query",
            "description": "Start Date",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "end",
            "in": "query",
            "description": "End Date",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "kpis",
            "in": "query",
            "description": "String separated by commas for the KPIs you want to fetch, here are the following options: net-profit-margin, gross-profit-margin",
            "required": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n\t\"data\": {\n\t\t\"grossProfitMargin\": {\n\t\t\t\"2022-09-30\": 87.88652112999304,\n\t\t\t\"2022-10-31\": 86.5861166061919,\n\t\t\t\"2022-11-30\": -3052.6191666666664,\n\t\t\t\"2022-12-31\": 83.21666666666667\n\t\t},\n\t\t\"netProfitMargin\": {\n\t\t\t\"2022-09-30\": 87.88652112999304,\n\t\t\t\"2022-10-31\": 86.5861166061919,\n\t\t\t\"2022-11-30\": -3052.6191666666664,\n\t\t\t\"2022-12-31\": 83.21666666666667\n\t\t}\n\t}\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "grossProfitMargin": {
                          "type": "object",
                          "properties": {
                            "2022-09-30": {
                              "type": "number",
                              "example": 87.88652112999304,
                              "default": 0
                            },
                            "2022-10-31": {
                              "type": "number",
                              "example": 86.5861166061919,
                              "default": 0
                            },
                            "2022-11-30": {
                              "type": "number",
                              "example": -3052.6191666666664,
                              "default": 0
                            },
                            "2022-12-31": {
                              "type": "number",
                              "example": 83.21666666666667,
                              "default": 0
                            }
                          }
                        },
                        "netProfitMargin": {
                          "type": "object",
                          "properties": {
                            "2022-09-30": {
                              "type": "number",
                              "example": 87.88652112999304,
                              "default": 0
                            },
                            "2022-10-31": {
                              "type": "number",
                              "example": 86.5861166061919,
                              "default": 0
                            },
                            "2022-11-30": {
                              "type": "number",
                              "example": -3052.6191666666664,
                              "default": 0
                            },
                            "2022-12-31": {
                              "type": "number",
                              "example": 83.21666666666667,
                              "default": 0
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "6202883ef5f761000f767440:62bb41e083a91904413d7765"
}
```