Version: v2

ILT service

A call to the income and burden evaluation results in an analysis divided in multiple indicators. The result can be used by our clients to evaluate the income and burdens 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 ILT service

Endpoint:             https://linx.invers.nl:8100/api/linx/indicator/ilt
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 ILT indicators

Indicator name	Analysis based on transactions
alimony-paid	Paid partner- and child alimony.
alimony-received	Received partner- and child alimony.
car-insurance	Car insurance costs
car-lease	Private lease
child-day-care	Day care costs
household-costs-energy	Energy costs.
household-costs-insurance	Costs for the house and contents insurance policies.
household-costs-water	Water costs.
income-other	Income transactions not processed in other indicators.
loan-debt-received	Incurred debt.
loan-mortgage	Payoff a mortgage loan, used to finance a house.
loan-payoff	Debt paid off
loan-student-debt-received	Debts incurred by a loan, provided by DUO (Dienst Uitvoering Onderwijs) used to finance education.
loan-student-payoff	Debts paid off for a loan, provided by DUO (Dienst Uitvoering Onderwijs) used to finance education.
local-taxes	Municipality and water authority taxes.
participation-law-welfare	Participation law welfare (bijstand).
pension	Retirement income received from a pension fund.
rent	Paid rent for an apartment / house.
salary	Income received from a salary paid by an employer.
tax-benefit-child-budget	Received child budget tax benefit (kindgebonden budget), paid by the Dutch tax authority.
tax-benefit-child-day-care	Received day-care tax benefit (kinderopvangtoeslag), paid by the Dutch tax authority.
tax-benefit-health-insurance	Received health insurance tax benefit (zorgtoeslag), paid by the Dutch tax authority.
tax-benefit-rent	Received rent tax benefit (huurtoeslag), paid by the Dutch tax authority.
tax-car	Payed tax for owning a car (motorrijtuigenbelasting), paid to the Dutch tax authority
tax-return-preliminary	Advance payment of the personal tax returns.
welfare-svb-child-benefit	Received welfare alimony for child benefit (kinderbijslag), paid by the Social verzekeringsbank (SVB).
welfare-svb-pension-aow	Received welfare alimony as an AOW pension (AOW), paid by the Social verzekeringsbank (SVB).
welfare-uwv-affection	Received welfare alimony for short-term illness or incapacitated (less than 2 years; ZW- and WAZO-uitkering), paid by Uitvoeringsinstituut Werknemersverzekeringen (UWV).
welfare-uwv-incapacitated	Received welfare alimony when incapacitated (over 2 years; WGA-, IVA-, WAZ-, WAO-, WIA- and WAJONG-uitkering), paid by Uitvoeringsinstituut Werknemersverzekeringen (UWV).
welfare-uwv-unemployed	Received welfare alimony when unemployed (short-term; WW- and IOW-uitkering), paid by Uitvoeringsinstituut Werknemersverzekeringen (UWV).

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",
            "incassant": "string",
            "mandate": "string",
            "country": "string",
            "name": "string",
            "originalName": "string",
            "identifier": "string",
            "businessId": "int",
            "denominationId": "int"
          }
        }
      ]
    }
  ],
"transactions": {
  "$type": "string",
  "$values": [
    {
      "$type": "string",
      "properties": [],
      "id": "string",
      "bookDate": "string",
      "interestDate": "string",
      "amount": "float",
      "count": "int",
      "endBalance": "float",
      "transactionCode": {
        "type": "string",
        "code": "string",
        "name": "string",
        "recurrent": "string"
      },
      "description": "string",
      "originalDescription": "string",
      "beneficiary": {
        "$type": "string",
        "type": "string",
        "number": "string",
        "formatted": "string",
        "iBan": "string",
        "incassant": "string",
        "mandate": "string",
        "country": "string",
        "name": "string",
        "originalName": "string",
        "identifier": "string",
        "businessId": "int",
        "denominationId": "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": "YYYY-MM-DDTHH:MM:SS+HH:MM",
    "dateTo": "YYYY-MM-DDTHH:MM:SS+HH:MM",
    "weight": "float",
    "credit": {
      "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": []
    },
    "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": []
    }
  }
],
"total": {
  "dateFrom": "YYYY-MM-DDTHH:MM:SS+HH:MM",
  "dateTo": "YYYY-MM-DDTHH:MM:SS+HH:MM",
  "weight": "float",
  "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": [
      {
        "id": "int",
        "weight": "float"
      }
    ],
    "paymentTypes": [
      {
        "type": "string",
        "count": "int"
      }
    ]
  },
  "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": "float"
      }
    ],
    "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"
      }
    ]
  }
},
"lastThreeMonths": {
  "dateFrom": "YYYY-MM-DDTHH:MM:SS+HH:MM",
  "dateTo": "YYYY-MM-DDTHH:MM:SS+HH:MM",
  "weight": "float",
  "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"
      }
    ]
  }
}
]

Calling the ILT service​

Available ILT indicators​

Output (Example)​

Calling the ILT service

Available ILT indicators

Output (Example)