Skip to content

Connectors

Here you can find different "connectors" to connect to other data sources or intelligence apps.

Condition

Here you can find the states of different connectors

  • Method: GET
  • Path: /api/finux/user/connector/condition
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

expected response:

{
    "status": {
        "message": "OK"
    },
    "data": {
        "states": {
            "XS2A": "bool",
            "GMI": "bool",
            "USERNAME": "bool",
            "COMPANYNAME": "bool",
            "ISDEMO": "bool"
        }
    },
    "code": 200
}

BankAccount

Here you can find all endpoints to interact with the bank-account.

Connect bank-account

Connect a bank-account so that FINUX can help you to find some important information.

  • Method: POST
  • Path: /api/finux/user/connector/bank/account
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

expected request:

{
  "bankCode": "string",
  "extraSecret": "string",
  "saveSecret": "true",
  "secret": "string",
  "username": "string"
}

expected response:

{
    "status": {
        "message": "OK"
    },
    "code": 200,
    "data": null
}

custom errors:

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

or provider error:

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

Upload Custom Bank Data

Instead of connecting a bank-account you can also manually upload custom account and transaction data to simulate a bank-account. In the background we'll create a "fake account" that can then be used to call other intelligence endpoints.

  • Method: POST
  • Path: /api/finux/user/connector/bank/upload
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

expected request:

{
    "accountData": [
        {
            "accountId": "string",
            "accountNumber": "string",
            "balance": "float64",
            "bankCode": "string",
            "bankLoginId": "string",
            "bankName": "string",
            "bic": "string",
            "creditLine": "float64",
            "currency": "string",
            "iban": "string",
            "icon": "string",
            "monthlySpendingLimit": "float64",
            "name": "string",
            "owner": "string",
            "isActive": "bool",
            "pagination": {
                "limit": "uint",
                "offset": "uint",
                "total": "uint"
            },
            "tags": [
                "string"
            ],
            "transactions": [
                {
                    "accountId": "string",
                    "amount": "float64",
                    "bookingText": "string",
                    "creditorId": "string",
                    "currency": "string",
                    "bookingDate": "int64",
                    "valueDate": "int64",
                    "mref": "string",
                    "paymentPartner": {
                        "bic": "string",
                        "creditorId": "string",
                        "iban": "string",
                        "name": "string"
                    },
                    "purpose": "string",
                    "sepaPurposeCode": "string",
                    "transactionCode": "int64",
                    "transactionId": "string",
                    "typeOfDebit": "string",
                    "typeOfTransaction": "string",
                    "tags": [
                        "string"
                    ]
                }
            ],
            "type": "string"
        }
    ]
}

expected response:

{
    "status": {
        "message": "OK"
    },
    "code": 200,
    "data": null
}

custom errors:

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

or provider error:

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

Get all bank-accounts

Get information about the connected bank account(s)

  • Method: GET
  • Path: /api/finux/user/connector/bank/account
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken> (optional)
  • Query: includeTransactions="bool" default is true with limit of 100 transactions limit="uint" offset="uint" optional parameter for field search: bic, creditorID, iban, name, amount bookingText, mref, sepaPurposeCode, transactionCode, purpose, tag optional for full text search: textSearch optional time filter from & to in RFC3999 and time sort=(asc|dsc)

expected response:

{
    "status": {
        "message": "OK"
    },
    "code": 200,
    "data": {
        "accounts": [
            {
                "accountId": "string",
                "accountNumber": "string",
                "balance": "float64",
                "bankCode": "string",
                "bankLoginId": "string",
                "bankName": "string",
                "bic": "string",
                "creditLine": "float64",
                "currency": "string",
                "iban": "string",
                "icon": "string",
                "monthlySpendingLimit": "float64",
                "name": "string",
                "owner": "string",
                "isActive": "bool",
                "pagination": {
                    "limit": "uint",
                    "offset": "uint",
                    "total": "uint"
                },
                "tags": [
                    "string"
                ],
                "transactions": [
                    {
                        "accountId": "string",
                        "amount": "float64",
                        "bookingText": "string",
                        "creditorId": "string",
                        "currency": "string",
                        "bookingDate": "int64",
                        "valueDate": "int64",
                        "mref": "string",
                        "paymentPartner": {
                            "bic": "string",
                            "creditorId": "string",
                            "iban": "string",
                            "name": "string"
                        },
                        "purpose": "string",
                        "sepaPurposeCode": "string",
                        "transactionCode": "int64",
                        "transactionId": "string",
                        "typeOfDebit": "string",
                        "typeOfTransaction": "string",
                        "tags": [
                            "string"
                        ]
                    }
                ],
                "type": "string"
            }
        ],
        "timestampLastSync": "int",
        "usedProvider": "string"
    }
}

Get specific bank-account

Get information about a specific bank-account. For that you need a accountId.

  • Method: GET
  • Path: /api/finux/user/connector/bank/account/{accountid}
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken> (optional)
  • Query: default with limit of 100 transactions limit="uint" offset="uint" optional parameter for field search: bic, creditorID, iban, name, amount bookingText, mref, sepaPurposeCode, transactionCode, purpose, tag optional for full text search: textSearch optional time filter from & to in RFC3999 and time sort=(asc|dsc)

expected response:

{
    "status": {
        "message": "OK"
    },
    "code": 200,
    "data": {
        "account": {
            "accountId": "string",
            "accountNumber": "string",
            "balance": "float64",
            "bankCode": "string",
            "bankLoginId": "string",
            "bankName": "string",
            "bic": "string",
            "creditLine": "float64",
            "currency": "string",
            "iban": "string",
            "icon": "string",
            "monthlySpendingLimit": "float64",
            "name": "string",
            "owner": "string",
            "pagination": {
                "limit": "uint",
                "offset": "uint",
                "total": "uint"
            },
            "tags": [
                "string"
            ],
            "transactions": [
                {
                    "accountId": "string",
                    "amount": "float64",
                    "bookingText": "string",
                    "currency": "string",
                    "bookingDate": "int64",
                    "valueDate": "int64",
                    "mref": "string",
                    "paymentPartner": {
                        "bic": "string",
                        "creditorId": "string",
                        "iban": "string",
                        "name": "string"
                    },
                    "purpose": "string",
                    "sepaPurposeCode": "string",
                    "transactionCode": "int64",
                    "transactionId": "string",
                    "typeOfDebit": "string",
                    "typeOfTransaction": "string",
                    "tags": [
                        "string"
                    ]
                }
            ],
            "type": "string"
        }
    }
}

custom errors:

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

or provider error:

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

Disconnect specific bank-account

Disconnect a specific bank-account.

  • Method: DELETE
  • Path: /api/finux/user/connector/bank/login/{bankloginid}
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

expected response:

{
    "status": {
        "message": "OK"
    },
    "code": 200,
    "data": null
}

custom errors:

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

or provider error:

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

Change account selection

Changing selection for accounts has impact on other intelligence functionalities as only selected accounts will be used.

  • Method: PATCH
  • Path: /api/finux/user/connector/bank/accountids
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

expected request:

{
    "data" :[
        {
            "accountID": "string",
            "flag": "bool"
        }
    ]
}

expected response:

{
    "status": {
        "message": "OK"
    },
    "code": 200,
    "data": "nil"
}

custom errors:

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

or provider error:

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

getMyInvoices

get-my-invoices

Use GetMyInvoices to fetch all invoices from a user's GMI account.

Add GMI-Account-AccessToken

To add users GMI-Account, the accessToken is needed.

  • Method: POST
  • Path: /api/finux/user/connector/gmi/account
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

expected request:

{
    "token": "string",
    "name": "string"
}

expected response:

{
    "status": {
        "message": "OK"
    },
    "code": 200,
    "data": null
}

Delete GMI-Account-AccessToken

To delete a gmi access token

  • Method: DELETE
  • Path: /api/finux/user/connector/gmi/account/{token}
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

expected response:

{
    "status": {
        "message": "OK"
    },
    "code": 200,
    "data": "nil"
}

Get All GMI-Account-AccessToken

All tokens and the associated name (descriptions) are returned

  • Method: GET
  • Path: /api/finux/user/connector/gmi/account
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

expected response:

{
    "status": {
        "message": "OK"
    },
    "data": {
        "accessToken": [
            {
                "token": "string",
                "name":  "string",
                "valid": "bool"
            }
        ]
    },
    "code": 200
}

Update GMI-Account-AccessToken Name

This can be used to update a token name (description).

  • Method: PATCH
  • Path: /api/finux/user/connector/gmi/account
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

expected response:

{
    "token": "string",
    "name": "string"
}

Get all invoices

  • Method: GET
  • Path: /api/finux/user/connector/gmi/invoices
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

expected response:

{
   "status":{
      "message": "OK"
   },
   "code":200,
   "data":[
        {
            "primUid": "string",
            "supplierUid": "string",
            "invoiceNumber": "string",
            "invoiceDate": "string",
            "invoiceDueDate": "string",
            "netAmount": "string",
            "vat": "string",
            "grossAmount": "string",
            "currency": "string",
            "isArchived": "string",
            "isOcrCompleted": "int",
            "tags": "string",
            "note": "string",
            "source": "string",
            "filename": "string",
            "fileSize": "string",
            "paymentStatus": "string",
            "paymentMethod": "string",
            "paymentDetails": {
                "iban": "string",
                "bic": "string",
                "accountHolderName": "string",
                "accountNumber": "string",
                "bankName": "string",
                "bankAddress": "string",
                "sortCode": "string",
                "routingNumber": "string",
                "ifscCode": "string",
                "routingCode": "string"
            },
            "transactions": [
                {
                "accountId": "string",
                "amount": "float64",
                "bookingText": "string",
                "creditorId": "string",
                "currency": "string",
                "dateOfTransaction": "int64",
                "mref": "string",
                "paymentPartner": {
                    "bic": "string",
                    "creditorId": "string",
                    "iban": "string",
                    "name": "string"
                },
                "purpose": "string",
                "sepaPurposeCode": "string",
                "transactionCode": "int64",
                "transactionId": "string",
                "typeOfDebit": "string",
                "typeOfTransaction": "string"
                }
            ]
        }
    ]
}

DemoUser

Connect demo user

The user is linked to a demo account, depending on the tenant's configuration. All previous information such as BankAccount, GMI, etc. are lost and can not be restored.

  • Method: POST
  • Path: /api/finux/user/connector/demo/connect
  • Header: X-FINO-Authorization : Bearer <JWT-AccessToken>

expected response:

{
    "status": {
        "message": "OK"
    },
    "code": 200,
    "data": "nil"
}