Pivot service

The pivot service is intended to aggregate the bank transactions of a household (or client). Transactions of multiple accounts, possibly with several banks, are merged and totalized after which averages will be calculated.

LinX offers the following pivot results:

• Total per category per period. Aggregated per day, week, month, quarter, semester or year.
• Averages per category per period.

Note: Averages are calculated over continuous periods of complete months, i.e. transactions from the first day until the last day of each month. Incomplete months are ignored.

The categories that are used in the Pivot service can be found in the standard scheme (See Nibud scheme)

Calling the Pivot service

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

Header:               ApiKey:        string      (required)
                      X-Request-ID:  string      (required)
                      ClientId:      string      (optional)
                      InputHash:     string      (optional)
                      Options:       int         (optional)       (default = 33)
                      Unit:          int         (optional)       (default  = 0)
                      KvK:           json        (optional)
                      SBI:           string      (optional)
  
Possible values:      0 = None
                      1 = Day
                      2 = Week
                      3 = Month
                      4 = Quarter
                      5 = Semester
                      6 = Year

Body:                 Data:       byte[]      (Required)

Errors:               400, 403 of 500

Information

Field	Type	Description
from	Datum	Date of first transaction
to	Datum	Date of last transaction
unit	Enum	None=0 Day=1 Week=2 Month=3 Quarter=4 Semester=5 Jaar=6
groups	Array of groups	Groups

Group

Field	Type	Description
id	Integer	Group identifier
name	String	Group name
categories	Array of categories	categories
amount	Float	Total amount
average	Float	Average amount
count	Float	Number of aggregated transactions

Category

Field	Type	Description
id	Integer	Category identifier
name	String	Category name
type	Enum	None = 0 Income = 1 Expenses = 2
amount	Float	Totaal bedrag
average	Float	Average amount
count	Integer	Number of aggregated transactions
values	Array of the values	The values of the aggregation

Value

Field	Type	Description
from	Date	Start date
to	Date	End date
amount	Float	Amount
count	Integer	Number of transactions in this period

Output (example)

{
  "from": "YYYY-MM-DDTHH:MM:SS+HH:MM",
  "to": "YYYY-MM-DDTHH:MM:SS+HH:MM",
  "unit": "none",
  "groups": [
    {
      "id": 0,
      "name": "string",
      "categories": [
        {
          "id": 0,
          "name": "string",
          "type": "none",
          "amount": 0,
          "average": 0,
          "count": 0,
          "values": [
            {
              "from": "YYYY-MM-DDTHH:MM:SS+HH:MM",
              "to": "YYYY-MM-DDTHH:MM:SS+HH:MM",
              "amount": 0,
              "count": 0
            }
          ]
        }
      ],
      "amount": 0,
      "average": 0,
      "count": 0,
      "values": [
        {
          "from": "YYYY-MM-DDTHH:MM:SS+HH:MM",
          "to": "YYYY-MM-DDTHH:MM:SS+HH:MM",
          "amount": 0,
          "count": 0
        }
      ]
    }
  ]
}