Skip to content

intelligence

Here you will find all intelligence of FINUX. We calculate a lot of magic stuff. And all of this you will find here. If you have more ideas to improve or expand our intelligence, don't hesitate to contact us!

Forecast

Get forecast

This endpoint returns the calculated daily balances of the last months and the mean forecast for the upcoming months.

  • Methode: GET
  • Path: /api/user/intelligence/liquidity
  • Header: `X-FINO-Authorization : Bearer

expected response:

{
    "status": {
        "message": "OK"
    },
    "code": 200,
    "data": [
        {
            "date": "string",
            "balance": "float64"
        }
    ]
}

custom errors:

{
    "status": {
        "message": "keyToi18nText"
    },
    "data": null,
    "code": 473
}

or provider error:

{
    "status": {
        "message": "ProviderMessage"
    },
    "data": null,
    "code": 422
}

Payments

Get Future Payments

Returns future payments for the selected account

  • Methode: GET
  • Path: api/user/intelligence/futurepayment
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

tagtype: "futurePaymentVat", "futurePaymentSalary", "futurePaymentFixcosts" for the header

expected response:

{
    "status": {
        "message": "OK"
    },
    "data": [
        "futurepayment": [
            {
                "description": "string",
                "paymentDate": "string",
                "amount": "float64",
                "balance": "float64",
                "paymentType": "tagtype"
            }
        ]
    ],
    "code": 200
}

custom errors:

{
    "status": {
        "message": "keyToi18nText"
    },
    "data": null,
    "code": 473
}

or provider error:

{
    "status": {
        "message": "ProviderMessage"
    },
    "data": null,
    "code": 422
}

Partners

Get top customers and suppliers

Returns top customers and suppliers of all bank-accounts, ZpType indicates Type customer or supplier

  • Methode: GET
  • Path: `/api/user/intelligence/tcas
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

  • Query parameter:

    • view = (amount|percent)
    • span = (year|quartal|month)
    • count = (all|top3)

count is only supported on amount view

expected response:

{
    "status": {
        "message": "OK"
    },
    "code": 200,
    "data": [
        {
            "cum_perc": "float64",
            "paymentPartnerName": "string",
            "rank": "int32",
            "totalAmountZP": "int64",
            "totalPercentageShare": "float64",
            "zpType": "string"
        }
    ]
}

custom errors:

{
  "status": {
      "message": "keyToi18nText"
  },
  "data": null,
  "code": 473
}

or provider error:

{
    "status": {
        "message": "ProviderMessage"
    },
    "data": null,
    "code": 422
}

Smartalerts

Get Smartalerts

Returns smartalerts based on tractions and user-feedbacks

  • Methode: GET
  • Path: api/user/intelligence/smartalerts
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

expected response:

{
    "status": {
        "message": "OK"
    },
    "data": [
        {
            "message": "string",
            "feedtype": "Feedback"
        },
        {
            "name": "string",
            "value": "int",
            "sum": "float",
            "feedtype": "Smartalert"
        }
    ],
    "code": 200
}

custom errors:

{
    "status": {
        "message": "keyToi18nText"
    },
    "data": null,
    "code": 473
}

or provider error:

{
    "status": {
        "message": "ProviderMessage"
    },
    "data": null,
    "code": 422
}

Daily Review

Get Review

Returns daily review based on transactions

  • Methode: POST
  • Path: /api/user/intelligence/review
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

expected response:

{
    "from": "string",
    "to": "string"
}

expected response:

{
    "status": {
        "message": "OK"
    },
    "data": {
        "payments": [
            {
                "paymentDate":  "string",
                "amount":       "float64",
                "purpose":      "string",
                "supplierName": "string"
            }
        ],
        "outgoing": "float64",
        "interval": "string",
        "from":     "string",
        "to":       "string"
    },
    "code": 200
}