Indicator business service

A call to the business indicators results in an analysis reported in multiple indicators. The result can be used by our clients to evaluate the creditworthiness of a data set. Each indicator contains a statistical analysis performed on a specific subset of transactions. The output and calculation of an individual indicator is discussed on the page about the indicator output. Here, the transaction subsets for these different analyses are discussed.

Calling the Indicator business service

Endpoint:             https://linx.invers.nl:8100/api/linx/indicator/business
Method:               POST

Header:               ApiKey:           string      (Required)
                      X-Request-ID:     string      (required)
                      ClientId:         string      (optional)
                      InputHash:        string      (optional)
                      KvK:              json        (optional)
                      SBI:              string      (optional)
                      DateRange:        json        (optional)
                      ReportingPeriod:  json        (optional)

Body:                 Data:             byte[]      (required)

Errors:               400, 403 or 500

For more information about the DateRange and ReportingPeriod header see Headers for calling the ILT and indicator business services.

Available Indicator Business indicators

Indicator name	Analysis based on transactions
automatic-collection-reversal	Reverted transactions (storno's).
balance	Analysis of the balance (see balance indicator for output structure).
debt-collector	Transactions where the beneficiary is a debt collector (deurwaarders en/of incassobureau).
income-not-revenue	Income transactions not-marked as revenue.
loan-debt-received	Incurred debt.
loan-payoff	Debt paid off.
revenue	Transactions marked as revenue.
tax-corporation	Paid corporation tax (vennootschapsbelasting).
tax-income	Paid income tax (inkomstenbelasting), relevant for sole proprietorship (ZZP'ers).
tax-payroll	Paid payroll tax (loonbelasting).
tax-vat	Paid value-added taxe (VAT; btw).
total-expense	All expense non-internal transactions (note, that the interactions are grouped by category and not by beneficiary).
total-income	All income non-internal transactions (note, that the interactions are grouped by category and not by beneficiary).

Output (Example)

{
  "indicators": [
    {
      "$type": "string",
      "name": "string",
      "accounts": [
        {
          "id": "int",
          "accountNumber": "string"
        }
      ],
      "beneficiaries": [
        {
          "id": "int",
          "beneficiary": {
            "$type": "string",
            "type": "string",
            "number": "string",
            "formatted": "string",
            "iBan": "string",
            "country": "string",
            "name": "string",
            "originalName": "string",
            "businessId": "int"
          }
        }
      ]
    }
  ],
  "transactions": {
    "$type": "string",
    "$values": [
      {
        "$type": "string",
        "properties": [
          {
            "$type": "string",
            "value": "string",
            "displayValue": "string",
            "type": "string",
            "context": "string",
            "id": "int",
            "name": "string",
            "displayName": "string"
          },
          {
            "$type": "string",
            "value": "int",
            "displayValue": "string",
            "type": "string",
            "context": "string",
            "id": "int",
            "name": "string",
            "displayName": "string"
          },
          {
            "$type": "string",
            "value": "int",
            "items": [
              {
                "value": "int",
                "name": "string"
              },
              {
                "value": "int",
                "name": "string"
              },
              {
                "value": "int",
                "name": "string"
              },
              {
                "value": "int",
                "name": "string"
              },
              {
                "value": "int",
                "name": "string"
              },
              {
                "value": "int",
                "name": "string"
              }
            ],
            "displayValue": "string",
            "type": "picklist",
            "context": "string",
            "id": "int",
            "name": "string",
            "displayName": "string"
          },
          {
            "$type": "string",
            "value": "string",
            "displayValue": "string",
            "type": "string",
            "context": "string",
            "id": "int",
            "name": "string",
            "displayName": "string"
          }
        ],
        "id": "string",
        "bookDate": "string",
        "interestDate": "string",
        "amount": "int",
        "count": "int",
        "endBalance": "int",
        "transactionCode": {
          "type": "string",
          "code": "string",
          "name": "string",
          "recurrent": "string"
        },
        "description": "string",
        "originalDescription": "string",
        "beneficiary": {
          "$type": "string",
          "type": "string",
          "number": "string",
          "formatted": "string",
          "iBan": "string",
          "country": "string",
          "name": "string",
          "originalName": "string",
          "businessId": "int"
        },
        "sequence": "int",
        "categoryId": "int",
        "category": "string",
        "naceId": "int",
        "nace": {
          "id": "int",
          "code": "string",
          "description": "string"
        },
        "flags": "string"
      }
    ]
  },
  "interactions": [
    {
      "id": "int",
      "accountId": "int",
      "beneficiaryId": "int",
      "credit": {
        "transactionAmount": {
          "exp": "float",
          "min": "float",
          "max": "float",
          "var": "float",
          "std": "float"
        },
        "transactionInterval": {
          "exp": "float",
          "min": "float",
          "max": "float",
          "var": "float",
          "std": "float"
        },
        "transactionIntervalUnitMonth": true,
        "periodAmount": {
          "exp": "float",
          "min": "float",
          "max": "float",
          "var": "float",
          "std": "float"
        },
        "numberOfTransactions": "int",
        "firstTransactionRecordDate": "string",
        "isFirstTransaction": true,
        "lastTransactionRecordDate": "string",
        "isLastTransaction": true,
        "paymentTypes": [
          {
            "type": "string",
            "count": "int"
          }
        ]
      },
      "debit": {
        "transactionAmount": {
          "exp": "float",
          "min": "float",
          "max": "float",
          "var": "float",
          "std": "float"
        },
        "transactionInterval": {
          "exp": "float",
          "min": "float",
          "max": "float",
          "var": "float",
          "std": "float"
        },
        "transactionIntervalUnitMonth": true,
        "periodAmount": {
          "exp": "float",
          "min": "float",
          "max": "float",
          "var": "float",
          "std": "float"
        },
        "numberOfTransactions": "int",
        "firstTransactionRecordDate": "string",
        "isFirstTransaction": true,
        "lastTransactionRecordDate": "string",
        "isLastTransaction": true,
        "paymentTypes": [
          {
            "type": "string",
            "count": "int"
          }
        ]
      }
    }
  ],
  "periods": [
    {
      "dateFrom": "string",
      "dateTo": "string",
      "weight": "float",
      "credit": {
        "expectedTotalAmount": {
          "exp": "float",
          "min": "float",
          "max": "float",
          "var": "float",
          "std": "float"
        },
        "realisedTotalAmount": "float",
        "numOfAccounts": "int",
        "numOfBeneficiaries": "int",
        "numberOfTransactions": "int",
        "indicatorInteractionWeights": [],
        "paymentTypes": []
      },
  "debit": {
    "expectedTotalAmount": {
      "exp": "float",
      "min": "float",
      "max": "float",
      "var": "float",
      "std": "float"
    },
    "realisedTotalAmount": "float",
    "numOfAccounts": "int",
    "numOfBeneficiaries": "int",
    "numberOfTransactions": "int",
    "indicatorInteractionWeights": [
      {
        "id": "int",
        "weight": "float"
      }
    ],
    "paymentTypes": []
  },
  "total": {
    "expectedTotalAmount": {
      "exp": "float",
      "min": "float",
      "max": "float",
      "var": "float",
      "std": "float"
    },
    "realisedTotalAmount": "float",
    "numOfAccounts": "int",
    "numOfBeneficiaries": "int",
    "numberOfTransactions": "int",
    "paymentTypes": []
},
"lastThreeMonths": {
  "dateFrom": "string",
  "dateTo": "string",
  "weight": "int",
  "credit": {
    "expectedTotalAmount": {
      "exp": "float",
      "min": "float",
      "max": "float",
      "var": "float",
      "std": "float"
    },
    "realisedTotalAmount": "float",
    "expectedAmountPerPeriod": {
      "exp": "float",
      "min": "float",
      "max": "float",
      "var": "float",
      "std": "float"
    },
    "numOfAccounts": "int",
    "numOfBeneficiaries": "int",
    "numberOfTransactions": "int",
    "indicatorInteractionWeights": [],
    "paymentTypes": []
  },
  "debit": {
    "expectedTotalAmount": {
      "exp": "float",
      "min": "float",
      "max": "float",
      "var": "float",
      "std": "float"
    },
    "realisedTotalAmount": "float",
    "expectedAmountPerPeriod": {
      "exp": "float",
      "min": "float",
      "max": "float",
      "var": "float",
      "std": "float"
    },
    "numOfAccounts": "int",
    "numOfBeneficiaries": "int",
    "numberOfTransactions": "int",
    "indicatorInteractionWeights": [
      {
        "id": "int",
        "weight": "int"
      }
    ],
    "paymentTypes": [
      {
        "type": "string",
        "count": "int"
      }
    ]
  },
  "total": {
    "expectedTotalAmount": {
      "exp": "float",
      "min": "float",
      "max": "float",
      "var": "float",
      "std": "float"
    },
    "realisedTotalAmount": "float",
    "expectedAmountPerPeriod": {
      "exp": "float",
      "min": "float",
      "max": "float",
      "var": "float",
      "std": "float"
    },
    "numOfAccounts": "int",
    "numOfBeneficiaries": "int",
    "numberOfTransactions": "int",
    "paymentTypes": [
      {
        "type": "string",
        "count": "int"
      }
    ]
  }
}