LinX API (Deprecated)

Consents

/api/v1/Consents/generateConsentWizardUrl

Starts a new consentwizard session with the specified parameters. For more detailed information on usage and parameters see the "API documentation" tab on the LinX DevPortal website.

path Parameters

version

required

string

query Parameters

consentCollectionId required	string Identifier of the Consent Collection, unique GUID for this collection
returnUrl required	string Redirect URL after consent has been given
customerSubType	string Optional.
collectionType	integer <int32> Default: 1 Optional.

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ExpectedIbans	string

Responses

Response samples

Content type

application/json

{"url": "string",
"requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

/api/v1/Consents/generateUrl

path Parameters

version

required

string

query Parameters

consentCollectionId required	string
returnUrl required	string
bankId required	string
collectionType	integer <int32> Default: 1

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
Ibans	string

Responses

Response samples

Content type

application/json

{"consentRequestUrl": "string",
"consentCollectionId": "string",
"requestId": "string"
}

/api/v1/Consents/info

path Parameters

version

required

string

query Parameters

consentCollectionId

required

string

The ConsentCollectionId

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>

Responses

Response samples

Content type

application/json

[{"consentedOn": "2019-08-24T14:15:22Z",
"bankId": "30a36e6b-4ce6-409a-8471-fa29e9999b3a",
"bankName": "string",
"expiresOn": "2019-08-24T14:15:22Z",
"fromHistoryDate": "2019-08-24T14:15:22Z",
"status": "0 = Received",
"accounts": [{"iBan": "string",
"status": "0 = None",
"lastdownload": "2019-08-24T14:15:22Z",
"historyAvailable": true,
"name": "string",
"product": "string"
}
]
}
]

/api/v1/Consents/accounts

path Parameters

version

required

string

query Parameters

consentCollectionId

required

string

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>

Responses

Response samples

Content type

application/json

[{"iBan": "string",
"lastdownload": "2019-08-24T14:15:22Z",
"historyAvailable": true,
"name": "string",
"product": "string",
"bankId": "30a36e6b-4ce6-409a-8471-fa29e9999b3a",
"bankName": "string",
"consentedOn": "2019-08-24T14:15:22Z",
"expiresOn": "2019-08-24T14:15:22Z",
"fromHistoryDate": "2019-08-24T14:15:22Z",
"status": "0 = None"
}
]

/api/v1/Consents/clearCollection

path Parameters

version

required

string

query Parameters

consentCollectionId

required

string <uuid>

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>

Responses

Response samples

Content type

application/json

{"clearSuccessfull": true,
"collectionId": "0ffe69e2-b7af-4b1e-835c-867376165f50",
"message": "string"
}

Status

/api/v1/Status/BankHealth

path Parameters

version

required

string

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>

Responses

Response samples

Content type

application/json

[{"bankId": "30a36e6b-4ce6-409a-8471-fa29e9999b3a",
"bankName": "string",
"bankStatus": "0 = Down",
"statusHeldSince": "2019-08-24T14:15:22Z"
}
]

LinX

/api/linx/convert

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ClientId	string
ConsentCollectionId	string <uuid>
Options	integer
KvK	string
SBI	string
IncludePending	boolean
Businesses	string <json>
Virtuals	string <json>

Request Body schema: application/json
required

The file to process

file

Responses

Request samples

Payload

Content type

application/json

null

Response samples

Content type

application/json

{"format": "string",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"accounts": [{"id": 0,
"country": "string",
"name": "string",
"originalName": "string",
"reference": "string",
"businessId": 0,
"business": {"id": 0,
"name": "string",
"country": "string",
"number": "string",
"subsidiary": "string",
"addresses": [{"id": "string",
"default": true,
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"zipcode": "string",
"city": {"id": "string",
"name": "string"
},
"municipality": {"id": "string",
"name": "string"
},
"province": {"id": "string",
"name": "string"
},
"country": "string",
"type": "string",
"purpose": "0 = Unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0.1,
"longitude": 0.1
}
],
"contacts": [{"type": "0 = Email",
"value": "string"
}
],
"activities": [{"code": "string",
"name": "string",
"isMain": true
}
],
"tradenames": ["string"
]
},
"number": "string",
"formattedNumber": "string",
"iBan": "string",
"swiftCode": "string",
"beginBalanceDate": "2019-08-24T14:15:22Z",
"beginBalance": 0.1,
"endBalanceDate": "2019-08-24T14:15:22Z",
"endBalance": 0.1,
"bank": {"id": 0,
"country": "string",
"bic": "string",
"name": "string",
"formats": "string",
"downloadUrl": "string",
"iconUrl": "string",
"infoUrl": "string",
"isActive": true,
"isVisible": true,
"sortOrder": 0,
"syncKey": "string"
},
"transactions": [{"id": "string",
"bookDate": "2019-08-24T14:15:22Z",
"interestDate": "2019-08-24T14:15:22Z",
"transactionDate": "2019-08-24T14:15:22Z",
"amount": 0.1,
"count": 0,
"endBalance": 0.1,
"beneficiary": {"id": 0,
"country": "string",
"name": "string",
"originalName": "string",
"reference": "string",
"businessId": 0,
"business": {"id": 0,
"name": "string",
"country": "string",
"number": "string",
"subsidiary": "string",
"addresses": [{"id": "string",
"default": true,
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"zipcode": "string",
"city": {"id": null,
"name": null
},
"municipality": {"id": null,
"name": null
},
"province": {"id": null,
"name": null
},
"country": "string",
"type": "string",
"purpose": "0 = Unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0.1,
"longitude": 0.1
}
],
"contacts": [{"type": "0 = Email",
"value": "string"
}
],
"activities": [{"code": "string",
"name": "string",
"isMain": true
}
],
"tradenames": ["string"
]
}
},
"code": {"id": 0,
"type": "0 = AC",
"code": "string",
"numeric": 0,
"name": "string"
},
"description": "string",
"originalDescription": "string",
"flags": "0 = None",
"sequence": 0,
"categoryId": 0,
"category": {"id": 0,
"name": "string",
"type": "0 = Invalid",
"costType": "7534 = None",
"isInternal": true,
"isStrict": true,
"color": 0,
"taxPost": "string",
"syncKey": "string",
"groupId": 0,
"nibuds": [0
],
"group": {"id": 0,
"name": "string",
"type": "0 = Invalid",
"isInternal": true,
"color": 0,
"syncKey": "string",
"categories": [{ }
]
},
"posten": [{"id": 0,
"name": "string",
"description": "string",
"years": [0
]
}
]
},
"naceId": 0,
"nace": {"id": 0,
"code": "string",
"description": "string"
},
"properties": [{"id": 0,
"type": "0 = None",
"context": "0 = Transaction",
"name": "string",
"value": "string",
"properties": [{ }
]
}
],
"contract": "string",
"externalTransactionId": "string",
"inversCategoryId": 0,
"customCategoryId": 0
}
]
}
],
"businesses": [{"id": 0,
"name": "string",
"country": "string",
"number": "string",
"subsidiary": "string",
"addresses": [{"id": "string",
"default": true,
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"zipcode": "string",
"city": {"id": "string",
"name": "string"
},
"municipality": {"id": "string",
"name": "string"
},
"province": {"id": "string",
"name": "string"
},
"country": "string",
"type": "string",
"purpose": "0 = Unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0.1,
"longitude": 0.1
}
],
"contacts": [{"type": "0 = Email",
"value": "string"
}
],
"activities": [{"code": "string",
"name": "string",
"isMain": true
}
],
"tradenames": ["string"
]
}
],
"groups": [{"id": 0,
"name": "string",
"type": "0 = Invalid",
"isInternal": true,
"color": 0,
"syncKey": "string",
"categories": [{"id": 0,
"name": "string",
"type": "0 = Invalid",
"costType": "7534 = None",
"isInternal": true,
"isStrict": true,
"color": 0,
"taxPost": "string",
"syncKey": "string",
"groupId": 0,
"nibuds": [0
],
"group": { },
"posten": [{"id": 0,
"name": "string",
"description": "string",
"years": [0
]
}
]
}
]
}
],
"categories": [{"id": 0,
"name": "string",
"type": "0 = Invalid",
"costType": "7534 = None",
"isInternal": true,
"isStrict": true,
"color": 0,
"taxPost": "string",
"syncKey": "string",
"groupId": 0,
"nibuds": [0
],
"group": {"id": 0,
"name": "string",
"type": "0 = Invalid",
"isInternal": true,
"color": 0,
"syncKey": "string",
"categories": [{ }
]
},
"posten": [{"id": 0,
"name": "string",
"description": "string",
"years": [0
]
}
]
}
],
"naces": [{"id": 0,
"code": "string",
"description": "string"
}
]
}

/api/linx/banks

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ClientId	string

Responses

Response samples

Content type

application/json

[{"id": 0,
"country": "string",
"bic": "string",
"name": "string",
"formats": "string",
"downloadUrl": "string",
"iconUrl": "string",
"infoUrl": "string",
"isActive": true,
"isVisible": true,
"sortOrder": 0,
"syncKey": "string"
}
]

/api/linx/categories

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ClientId	string

Responses

Response samples

Content type

application/json

[{"id": 0,
"name": "string",
"type": "0 = Invalid",
"costType": "7534 = None",
"isInternal": true,
"isStrict": true,
"color": 0,
"taxPost": "string",
"syncKey": "string",
"groupId": 0,
"nibuds": [0
],
"group": {"id": 0,
"name": "string",
"type": "0 = Invalid",
"isInternal": true,
"color": 0,
"syncKey": "string",
"categories": [{ }
]
},
"posten": [{"id": 0,
"name": "string",
"description": "string",
"years": [0
]
}
]
}
]

/api/linx/groups

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ClientId	string

Responses

Response samples

Content type

application/json

[{"id": 0,
"name": "string",
"type": "0 = Invalid",
"isInternal": true,
"color": 0,
"syncKey": "string",
"categories": [{"id": 0,
"name": "string",
"type": "0 = Invalid",
"costType": "7534 = None",
"isInternal": true,
"isStrict": true,
"color": 0,
"taxPost": "string",
"syncKey": "string",
"groupId": 0,
"nibuds": [0
],
"group": { },
"posten": [{"id": 0,
"name": "string",
"description": "string",
"years": [0
]
}
]
}
]
}
]

/api/linx/paymentcodes

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ClientId	string

Responses

Response samples

Content type

application/json

[{"id": 0,
"type": "0 = AC",
"code": "string",
"numeric": 0,
"name": "string"
}
]

/api/linx/costtypes

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ClientId	string

Responses

Response samples

Content type

application/json

[{"id": 0,
"name": "string",
"syncKey": "string"
}
]

/api/linx/countries

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ClientId	string

Responses

Response samples

Content type

application/json

[{"id": 0,
"code": "string",
"name": "string",
"nativeName": "string",
"number": 0,
"languages": "string",
"tld": "string",
"capital": "string",
"region": "string",
"subRegion": "string",
"latitude": 0.1,
"longitude": 0.1,
"syncKey": "string",
"lcid": 0,
"isVisible": true,
"masks": [{"id": 0,
"type": "0 = None",
"value": "string"
}
],
"currencies": [{"id": 0,
"valuta": "string"
}
],
"isoCode": "string"
}
]

/api/linx/nibudmodel

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ClientId	string

Responses

Response samples

Content type

application/json

{"geslacht": [{"name": "string",
"value": "0 = Man"
}
],
"bouwjaar": [{"name": "string",
"value": "0 = Voor1945"
}
],
"eigenRisico": [{"name": "string",
"value": "0 = Categorie1"
}
],
"energielabel": [{"name": "string",
"value": "0 = Onbekend"
}
],
"schooltype": [{"name": "string",
"value": "0 = Geen"
}
],
"soortWoning": [{"name": "string",
"value": "0 = Huurwoning"
}
],
"typeWoning": [{"name": "string",
"value": "0 = VrijstaandGroot"
}
],
"statusAuto": [{"name": "string",
"value": "0 = Nieuw"
}
],
"woonsituatie": [{"name": "string",
"value": "0 = Thuiswonend"
}
],
"gemeentes": [{"id": 0,
"naam": "string"
}
],
"typeAuto": [{"name": "string",
"value": "0 = Geen"
}
],
"leeftijd": [{"name": "string",
"value": "0 = Nul_tot_en_met_vijf"
}
],
"kilometers": [{"name": "string",
"value": "0 = Less_Then_10000"
}
],
"wozWaardes": [{"name": "string",
"value": "0 = Less_Then_150000"
}
]
}

/api/linx/pivot

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ClientId	string
InputHash	string
Options	integer
Unit	integer
KvK	string
SBI	string

Request Body schema: application/json
required

File to process

file

Responses

Request samples

Payload

Content type

application/json

null

Response samples

Content type

application/json

{"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"unit": "0 = None",
"groups": [{"id": 0,
"name": "string",
"categories": [{"id": 0,
"name": "string",
"type": "0 = Invalid",
"amount": 0.1,
"average": 0.1,
"count": 0,
"values": [{"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"amount": 0.1,
"count": 0
}
]
}
],
"amount": 0.1,
"average": 0.1,
"count": 0,
"values": [{"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"amount": 0.1,
"count": 0
}
]
}
]
}

/api/linx/pivotgroup

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ClientId	string
InputHash	string
Options	integer
Unit	integer
KvK	string
SBI	string

Request Body schema: application/json
required

File to process

file

Responses

Request samples

Payload

Content type

application/json

null

Response samples

Content type

application/json

{"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"unit": "0 = None",
"groups": [{"id": 0,
"name": "string",
"categories": [{"id": 0,
"name": "string",
"type": "0 = Invalid",
"amount": 0.1,
"average": 0.1,
"count": 0,
"values": [{"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"amount": 0.1,
"count": 0
}
]
}
],
"amount": 0.1,
"average": 0.1,
"count": 0,
"values": [{"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"amount": 0.1,
"count": 0
}
]
}
]
}

/api/linx/aggregate

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ClientId	string
InputHash	string
SchemaId	integer

Request Body schema: application/json
required

The file to process

file

Responses

Request samples

Payload

Content type

application/json

null

Response samples

Content type

application/json

{"aggregated": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"nodes": [{"id": 0,
"name": "string",
"title": "string",
"description": "string",
"tooltip": "string",
"type": "0 = Invalid",
"costType": "7534 = None",
"voorbeeld": 0.1,
"basis": 0.1,
"nodes": [{ }
],
"categories": [{"id": 0,
"name": "string",
"type": "0 = Invalid",
"amount": 0.1,
"value": 0.1,
"count": 0
}
],
"posten": [{"id": 0,
"post": "string",
"name": "string",
"voorbeeld": 0.1,
"basis": 0.1
}
],
"amount": 0.1,
"value": 0.1,
"interpolatedAmount": 0.1,
"isEnabled": true,
"isVisible": true,
"syncKey": "string",
"parent": { }
}
],
"transactions": 0,
"categorized": 0,
"amount": 0.1,
"debit": 0.1,
"credit": 0.1,
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"imported": true
},
"profile": {"besteedbaarInkomen": 0.1,
"hoofdpersonen": [{"geboortedatum": "2019-08-24T14:15:22Z",
"geslacht": "0 = Man",
"eigenRisico": "0 = Categorie1"
}
],
"huisgenoten": [{"geboortedatum": "2019-08-24T14:15:22Z",
"geslacht": "0 = Man"
}
],
"kinderen": [{"geboortedatum": "2019-08-24T14:15:22Z",
"geslacht": "0 = Man",
"schooltype": "0 = Geen",
"woonsituatie": "0 = Thuiswonend",
"leeftijd": "0 = Nul_tot_en_met_vijf"
}
],
"autos": [{"kilometersPerJaar": 0,
"nieuwwaarde": 0.1,
"status": "0 = Nieuw",
"soort": "0 = Geen",
"kilometer": "0 = Less_Then_10000",
"voertuig": {"kenteken": "string",
"soort": "string",
"merk": "string",
"handelsbenaming": "string",
"inrichting": "string",
"datumTenaamstelling": "2019-08-24T14:15:22Z",
"zuinigheidslabel": "string",
"catalogusPrijs": 0.1,
"aantalZitplaatsen": 0,
"vervaldatumAPK": "2019-08-24T14:15:22Z",
"type": "string",
"variant": "string",
"taxi": "string",
"verzekerd": "string",
"brandstofEndpoint": "string",
"brandstof": [{"soort": "string",
"volgnummer": 0,
"verbruikBuiten": 0.1,
"verbruikGecombineerd": 0.1,
"verbruikStad": 0.1,
"cO2UitsootGecombineerd": 0.1,
"emissieCode": "string",
"geluidsniveau_Stationair": 0.1,
"kenteken": "string",
"milieuklasse_eg_goedkeuring_licht": "string",
"nettoMaximumVermogen": 0.1,
"geluidsniveau_Toerental": 0.1
}
]
}
}
],
"woning": {"bouwjaar": "0 = Voor1945",
"energielabel": "0 = Onbekend",
"soort": "0 = Huurwoning",
"typeWoning": "0 = VrijstaandGroot",
"wozWaarde": 0.1,
"woz": "0 = Less_Then_150000",
"huurPerMaand": 0.1,
"hypotheekPerMaand": 0.1,
"gemeenteId": 0,
"adres": {"id": "string",
"default": true,
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"zipcode": "string",
"city": {"id": "string",
"name": "string"
},
"municipality": {"id": "string",
"name": "string"
},
"province": {"id": "string",
"name": "string"
},
"country": "string",
"type": "string",
"purpose": "0 = Unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0.1,
"longitude": 0.1
}
},
"incomes": [{"id": 0,
"partner": true,
"title": "string",
"tooltip": "string",
"unit": "0 = None",
"div": 0,
"value": 0.1,
"categories": [{"id": 0,
"amount": 0.1
}
]
}
]
}
}

/api/linx/schemamodel

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
SchemaId	integer

Responses

Response samples

Content type

application/json

[{"id": 0,
"name": "string",
"title": "string",
"description": "string",
"nodes": [{"id": 0,
"name": "string",
"title": "string",
"description": "string",
"tooltip": "string",
"type": "0 = Invalid",
"costType": "7534 = None",
"voorbeeld": 0.1,
"basis": 0.1,
"nodes": [{ }
],
"categories": [{"id": 0,
"name": "string",
"type": "0 = Invalid",
"amount": 0.1,
"value": 0.1,
"count": 0
}
],
"posten": [{"id": 0,
"post": "string",
"name": "string",
"voorbeeld": 0.1,
"basis": 0.1
}
],
"amount": 0.1,
"value": 0.1,
"interpolatedAmount": 0.1,
"isEnabled": true,
"isVisible": true,
"syncKey": "string",
"parent": { }
}
],
"transactions": 0,
"categorized": 0,
"amount": 0.1,
"debit": 0.1,
"credit": 0.1,
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"imported": true
}
]

/api/linx/profile

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ClientId	string
InputHash	string

Request Body schema: application/json
required

The file to process

file

Responses

Request samples

Payload

Content type

application/json

null

Response samples

Content type

application/json

{"besteedbaarInkomen": 0.1,
"hoofdpersonen": [{"geboortedatum": "2019-08-24T14:15:22Z",
"geslacht": "0 = Man",
"eigenRisico": "0 = Categorie1"
}
],
"huisgenoten": [{"geboortedatum": "2019-08-24T14:15:22Z",
"geslacht": "0 = Man"
}
],
"kinderen": [{"geboortedatum": "2019-08-24T14:15:22Z",
"geslacht": "0 = Man",
"schooltype": "0 = Geen",
"woonsituatie": "0 = Thuiswonend",
"leeftijd": "0 = Nul_tot_en_met_vijf"
}
],
"autos": [{"kilometersPerJaar": 0,
"nieuwwaarde": 0.1,
"status": "0 = Nieuw",
"soort": "0 = Geen",
"kilometer": "0 = Less_Then_10000",
"voertuig": {"kenteken": "string",
"soort": "string",
"merk": "string",
"handelsbenaming": "string",
"inrichting": "string",
"datumTenaamstelling": "2019-08-24T14:15:22Z",
"zuinigheidslabel": "string",
"catalogusPrijs": 0.1,
"aantalZitplaatsen": 0,
"vervaldatumAPK": "2019-08-24T14:15:22Z",
"type": "string",
"variant": "string",
"taxi": "string",
"verzekerd": "string",
"brandstofEndpoint": "string",
"brandstof": [{"soort": "string",
"volgnummer": 0,
"verbruikBuiten": 0.1,
"verbruikGecombineerd": 0.1,
"verbruikStad": 0.1,
"cO2UitsootGecombineerd": 0.1,
"emissieCode": "string",
"geluidsniveau_Stationair": 0.1,
"kenteken": "string",
"milieuklasse_eg_goedkeuring_licht": "string",
"nettoMaximumVermogen": 0.1,
"geluidsniveau_Toerental": 0.1
}
]
}
}
],
"woning": {"bouwjaar": "0 = Voor1945",
"energielabel": "0 = Onbekend",
"soort": "0 = Huurwoning",
"typeWoning": "0 = VrijstaandGroot",
"wozWaarde": 0.1,
"woz": "0 = Less_Then_150000",
"huurPerMaand": 0.1,
"hypotheekPerMaand": 0.1,
"gemeenteId": 0,
"adres": {"id": "string",
"default": true,
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"zipcode": "string",
"city": {"id": "string",
"name": "string"
},
"municipality": {"id": "string",
"name": "string"
},
"province": {"id": "string",
"name": "string"
},
"country": "string",
"type": "string",
"purpose": "0 = Unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0.1,
"longitude": 0.1
}
},
"incomes": [{"id": 0,
"partner": true,
"title": "string",
"tooltip": "string",
"unit": "0 = None",
"div": 0,
"value": 0.1,
"categories": [{"id": 0,
"amount": 0.1
}
]
}
]
}

/api/linx/budget

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ClientId	string
InputHash	string

Request Body schema: application/json
required

The file to process

file

Responses

Request samples

Payload

Content type

application/json

null

Response samples

Content type

application/json

{"aggregated": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"nodes": [{"id": 0,
"name": "string",
"title": "string",
"description": "string",
"tooltip": "string",
"type": "0 = Invalid",
"costType": "7534 = None",
"voorbeeld": 0.1,
"basis": 0.1,
"nodes": [{ }
],
"categories": [{"id": 0,
"name": "string",
"type": "0 = Invalid",
"amount": 0.1,
"value": 0.1,
"count": 0
}
],
"posten": [{"id": 0,
"post": "string",
"name": "string",
"voorbeeld": 0.1,
"basis": 0.1
}
],
"amount": 0.1,
"value": 0.1,
"interpolatedAmount": 0.1,
"isEnabled": true,
"isVisible": true,
"syncKey": "string",
"parent": { }
}
],
"transactions": 0,
"categorized": 0,
"amount": 0.1,
"debit": 0.1,
"credit": 0.1,
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"imported": true
},
"profile": {"besteedbaarInkomen": 0.1,
"hoofdpersonen": [{"geboortedatum": "2019-08-24T14:15:22Z",
"geslacht": "0 = Man",
"eigenRisico": "0 = Categorie1"
}
],
"huisgenoten": [{"geboortedatum": "2019-08-24T14:15:22Z",
"geslacht": "0 = Man"
}
],
"kinderen": [{"geboortedatum": "2019-08-24T14:15:22Z",
"geslacht": "0 = Man",
"schooltype": "0 = Geen",
"woonsituatie": "0 = Thuiswonend",
"leeftijd": "0 = Nul_tot_en_met_vijf"
}
],
"autos": [{"kilometersPerJaar": 0,
"nieuwwaarde": 0.1,
"status": "0 = Nieuw",
"soort": "0 = Geen",
"kilometer": "0 = Less_Then_10000",
"voertuig": {"kenteken": "string",
"soort": "string",
"merk": "string",
"handelsbenaming": "string",
"inrichting": "string",
"datumTenaamstelling": "2019-08-24T14:15:22Z",
"zuinigheidslabel": "string",
"catalogusPrijs": 0.1,
"aantalZitplaatsen": 0,
"vervaldatumAPK": "2019-08-24T14:15:22Z",
"type": "string",
"variant": "string",
"taxi": "string",
"verzekerd": "string",
"brandstofEndpoint": "string",
"brandstof": [{"soort": "string",
"volgnummer": 0,
"verbruikBuiten": 0.1,
"verbruikGecombineerd": 0.1,
"verbruikStad": 0.1,
"cO2UitsootGecombineerd": 0.1,
"emissieCode": "string",
"geluidsniveau_Stationair": 0.1,
"kenteken": "string",
"milieuklasse_eg_goedkeuring_licht": "string",
"nettoMaximumVermogen": 0.1,
"geluidsniveau_Toerental": 0.1
}
]
}
}
],
"woning": {"bouwjaar": "0 = Voor1945",
"energielabel": "0 = Onbekend",
"soort": "0 = Huurwoning",
"typeWoning": "0 = VrijstaandGroot",
"wozWaarde": 0.1,
"woz": "0 = Less_Then_150000",
"huurPerMaand": 0.1,
"hypotheekPerMaand": 0.1,
"gemeenteId": 0,
"adres": {"id": "string",
"default": true,
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"zipcode": "string",
"city": {"id": "string",
"name": "string"
},
"municipality": {"id": "string",
"name": "string"
},
"province": {"id": "string",
"name": "string"
},
"country": "string",
"type": "string",
"purpose": "0 = Unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0.1,
"longitude": 0.1
}
},
"incomes": [{"id": 0,
"partner": true,
"title": "string",
"tooltip": "string",
"unit": "0 = None",
"div": 0,
"value": 0.1,
"categories": [{"id": 0,
"amount": 0.1
}
]
}
]
}
}

/api/linx/periodical_expenses

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ClientId	string
InputHash	string
Options	integer

Request Body schema: application/json
required

The file to process

file

Responses

Request samples

Payload

Content type

application/json

null

Response samples

Content type

application/json

[{"account": {"id": 0,
"country": "string",
"name": "string",
"originalName": "string",
"reference": "string",
"businessId": 0,
"business": {"id": 0,
"name": "string",
"country": "string",
"number": "string",
"subsidiary": "string",
"addresses": [{"id": "string",
"default": true,
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"zipcode": "string",
"city": {"id": "string",
"name": "string"
},
"municipality": {"id": "string",
"name": "string"
},
"province": {"id": "string",
"name": "string"
},
"country": "string",
"type": "string",
"purpose": "0 = Unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0.1,
"longitude": 0.1
}
],
"contacts": [{"type": "0 = Email",
"value": "string"
}
],
"activities": [{"code": "string",
"name": "string",
"isMain": true
}
],
"tradenames": ["string"
]
},
"number": "string",
"formattedNumber": "string",
"iBan": "string",
"swiftCode": "string",
"beginBalanceDate": "2019-08-24T14:15:22Z",
"beginBalance": 0.1,
"endBalanceDate": "2019-08-24T14:15:22Z",
"endBalance": 0.1,
"bank": {"id": 0,
"country": "string",
"bic": "string",
"name": "string",
"formats": "string",
"downloadUrl": "string",
"iconUrl": "string",
"infoUrl": "string",
"isActive": true,
"isVisible": true,
"sortOrder": 0,
"syncKey": "string"
},
"transactions": [{"id": "string",
"bookDate": "2019-08-24T14:15:22Z",
"interestDate": "2019-08-24T14:15:22Z",
"transactionDate": "2019-08-24T14:15:22Z",
"amount": 0.1,
"count": 0,
"endBalance": 0.1,
"beneficiary": {"id": 0,
"country": "string",
"name": "string",
"originalName": "string",
"reference": "string",
"businessId": 0,
"business": {"id": 0,
"name": "string",
"country": "string",
"number": "string",
"subsidiary": "string",
"addresses": [{"id": "string",
"default": true,
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"zipcode": "string",
"city": {"id": null,
"name": null
},
"municipality": {"id": null,
"name": null
},
"province": {"id": null,
"name": null
},
"country": "string",
"type": "string",
"purpose": "0 = Unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0.1,
"longitude": 0.1
}
],
"contacts": [{"type": "0 = Email",
"value": "string"
}
],
"activities": [{"code": "string",
"name": "string",
"isMain": true
}
],
"tradenames": ["string"
]
}
},
"code": {"id": 0,
"type": "0 = AC",
"code": "string",
"numeric": 0,
"name": "string"
},
"description": "string",
"originalDescription": "string",
"flags": "0 = None",
"sequence": 0,
"categoryId": 0,
"category": {"id": 0,
"name": "string",
"type": "0 = Invalid",
"costType": "7534 = None",
"isInternal": true,
"isStrict": true,
"color": 0,
"taxPost": "string",
"syncKey": "string",
"groupId": 0,
"nibuds": [0
],
"group": {"id": 0,
"name": "string",
"type": "0 = Invalid",
"isInternal": true,
"color": 0,
"syncKey": "string",
"categories": [{ }
]
},
"posten": [{"id": 0,
"name": "string",
"description": "string",
"years": [0
]
}
]
},
"naceId": 0,
"nace": {"id": 0,
"code": "string",
"description": "string"
},
"properties": [{"id": 0,
"type": "0 = None",
"context": "0 = Transaction",
"name": "string",
"value": "string",
"properties": [{ }
]
}
],
"contract": "string",
"externalTransactionId": "string",
"inversCategoryId": 0,
"customCategoryId": 0
}
]
},
"items": [{"probability": "0 = Medium",
"frequenceType": "0 = None",
"interval": 0,
"contract": "string",
"date": "2019-08-24T14:15:22Z",
"amount": 0.1,
"type": "0 = AC",
"category": {"id": 0,
"name": "string",
"type": "0 = Invalid",
"costType": "7534 = None",
"isInternal": true,
"isStrict": true,
"color": 0,
"taxPost": "string",
"syncKey": "string",
"groupId": 0,
"nibuds": [0
],
"group": {"id": 0,
"name": "string",
"type": "0 = Invalid",
"isInternal": true,
"color": 0,
"syncKey": "string",
"categories": [{ }
]
},
"posten": [{"id": 0,
"name": "string",
"description": "string",
"years": [0
]
}
]
},
"nace": {"id": 0,
"code": "string",
"description": "string"
},
"account": {"id": 0,
"country": "string",
"name": "string",
"originalName": "string",
"reference": "string",
"businessId": 0,
"business": {"id": 0,
"name": "string",
"country": "string",
"number": "string",
"subsidiary": "string",
"addresses": [{"id": "string",
"default": true,
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"zipcode": "string",
"city": {"id": "string",
"name": "string"
},
"municipality": {"id": "string",
"name": "string"
},
"province": {"id": "string",
"name": "string"
},
"country": "string",
"type": "string",
"purpose": "0 = Unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0.1,
"longitude": 0.1
}
],
"contacts": [{"type": "0 = Email",
"value": "string"
}
],
"activities": [{"code": "string",
"name": "string",
"isMain": true
}
],
"tradenames": ["string"
]
},
"number": "string",
"formattedNumber": "string",
"iBan": "string",
"bic": "string",
"incassant": "string",
"mandate": "string",
"targetBusinessId": 0,
"targetBusiness": {"id": 0,
"name": "string",
"country": "string",
"number": "string",
"subsidiary": "string",
"addresses": [{"id": "string",
"default": true,
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"zipcode": "string",
"city": {"id": "string",
"name": "string"
},
"municipality": {"id": "string",
"name": "string"
},
"province": {"id": "string",
"name": "string"
},
"country": "string",
"type": "string",
"purpose": "0 = Unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0.1,
"longitude": 0.1
}
],
"contacts": [{"type": "0 = Email",
"value": "string"
}
],
"activities": [{"code": "string",
"name": "string",
"isMain": true
}
],
"tradenames": ["string"
]
},
"targetName": "string"
},
"business": {"id": 0,
"name": "string",
"country": "string",
"number": "string",
"subsidiary": "string",
"addresses": [{"id": "string",
"default": true,
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"zipcode": "string",
"city": {"id": "string",
"name": "string"
},
"municipality": {"id": "string",
"name": "string"
},
"province": {"id": "string",
"name": "string"
},
"country": "string",
"type": "string",
"purpose": "0 = Unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0.1,
"longitude": 0.1
}
],
"contacts": [{"type": "0 = Email",
"value": "string"
}
],
"activities": [{"code": "string",
"name": "string",
"isMain": true
}
],
"tradenames": ["string"
]
},
"name": "string",
"description": "string",
"pattern": "string",
"transactions": [{"id": "string",
"bookDate": "2019-08-24T14:15:22Z",
"interestDate": "2019-08-24T14:15:22Z",
"transactionDate": "2019-08-24T14:15:22Z",
"amount": 0.1,
"count": 0,
"endBalance": 0.1,
"beneficiary": {"id": 0,
"country": "string",
"name": "string",
"originalName": "string",
"reference": "string",
"businessId": 0,
"business": {"id": 0,
"name": "string",
"country": "string",
"number": "string",
"subsidiary": "string",
"addresses": [{"id": null,
"default": null,
"street": null,
"houseNumber": null,
"houseNumberAddition": null,
"zipcode": null,
"city": null,
"municipality": null,
"province": null,
"country": null,
"type": null,
"purpose": null,
"surface": null,
"surfaceArea": null,
"latitude": null,
"longitude": null
}
],
"contacts": [{"type": null,
"value": null
}
],
"activities": [{"code": null,
"name": null,
"isMain": null
}
],
"tradenames": ["string"
]
}
},
"code": {"id": 0,
"type": "0 = AC",
"code": "string",
"numeric": 0,
"name": "string"
},
"description": "string",
"originalDescription": "string",
"flags": "0 = None",
"sequence": 0,
"categoryId": 0,
"category": {"id": 0,
"name": "string",
"type": "0 = Invalid",
"costType": "7534 = None",
"isInternal": true,
"isStrict": true,
"color": 0,
"taxPost": "string",
"syncKey": "string",
"groupId": 0,
"nibuds": [0
],
"group": {"id": 0,
"name": "string",
"type": "0 = Invalid",
"isInternal": true,
"color": 0,
"syncKey": "string",
"categories": [{ }
]
},
"posten": [{"id": 0,
"name": "string",
"description": "string",
"years": [null
]
}
]
},
"naceId": 0,
"nace": {"id": 0,
"code": "string",
"description": "string"
},
"properties": [{"id": 0,
"type": "0 = None",
"context": "0 = Transaction",
"name": "string",
"value": "string",
"properties": [{ }
]
}
],
"contract": "string",
"externalTransactionId": "string",
"inversCategoryId": 0,
"customCategoryId": 0
}
]
}
]
}
]

/api/linx/periodical_income

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ClientId	string
InputHash	string
Options	integer

Request Body schema: application/json
required

The file to process

file

Responses

Request samples

Payload

Content type

application/json

null

Response samples

Content type

application/json

[{"account": {"id": 0,
"country": "string",
"name": "string",
"originalName": "string",
"reference": "string",
"businessId": 0,
"business": {"id": 0,
"name": "string",
"country": "string",
"number": "string",
"subsidiary": "string",
"addresses": [{"id": "string",
"default": true,
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"zipcode": "string",
"city": {"id": "string",
"name": "string"
},
"municipality": {"id": "string",
"name": "string"
},
"province": {"id": "string",
"name": "string"
},
"country": "string",
"type": "string",
"purpose": "0 = Unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0.1,
"longitude": 0.1
}
],
"contacts": [{"type": "0 = Email",
"value": "string"
}
],
"activities": [{"code": "string",
"name": "string",
"isMain": true
}
],
"tradenames": ["string"
]
},
"number": "string",
"formattedNumber": "string",
"iBan": "string",
"swiftCode": "string",
"beginBalanceDate": "2019-08-24T14:15:22Z",
"beginBalance": 0.1,
"endBalanceDate": "2019-08-24T14:15:22Z",
"endBalance": 0.1,
"bank": {"id": 0,
"country": "string",
"bic": "string",
"name": "string",
"formats": "string",
"downloadUrl": "string",
"iconUrl": "string",
"infoUrl": "string",
"isActive": true,
"isVisible": true,
"sortOrder": 0,
"syncKey": "string"
},
"transactions": [{"id": "string",
"bookDate": "2019-08-24T14:15:22Z",
"interestDate": "2019-08-24T14:15:22Z",
"transactionDate": "2019-08-24T14:15:22Z",
"amount": 0.1,
"count": 0,
"endBalance": 0.1,
"beneficiary": {"id": 0,
"country": "string",
"name": "string",
"originalName": "string",
"reference": "string",
"businessId": 0,
"business": {"id": 0,
"name": "string",
"country": "string",
"number": "string",
"subsidiary": "string",
"addresses": [{"id": "string",
"default": true,
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"zipcode": "string",
"city": {"id": null,
"name": null
},
"municipality": {"id": null,
"name": null
},
"province": {"id": null,
"name": null
},
"country": "string",
"type": "string",
"purpose": "0 = Unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0.1,
"longitude": 0.1
}
],
"contacts": [{"type": "0 = Email",
"value": "string"
}
],
"activities": [{"code": "string",
"name": "string",
"isMain": true
}
],
"tradenames": ["string"
]
}
},
"code": {"id": 0,
"type": "0 = AC",
"code": "string",
"numeric": 0,
"name": "string"
},
"description": "string",
"originalDescription": "string",
"flags": "0 = None",
"sequence": 0,
"categoryId": 0,
"category": {"id": 0,
"name": "string",
"type": "0 = Invalid",
"costType": "7534 = None",
"isInternal": true,
"isStrict": true,
"color": 0,
"taxPost": "string",
"syncKey": "string",
"groupId": 0,
"nibuds": [0
],
"group": {"id": 0,
"name": "string",
"type": "0 = Invalid",
"isInternal": true,
"color": 0,
"syncKey": "string",
"categories": [{ }
]
},
"posten": [{"id": 0,
"name": "string",
"description": "string",
"years": [0
]
}
]
},
"naceId": 0,
"nace": {"id": 0,
"code": "string",
"description": "string"
},
"properties": [{"id": 0,
"type": "0 = None",
"context": "0 = Transaction",
"name": "string",
"value": "string",
"properties": [{ }
]
}
],
"contract": "string",
"externalTransactionId": "string",
"inversCategoryId": 0,
"customCategoryId": 0
}
]
},
"items": [{"probability": "0 = Medium",
"frequenceType": "0 = None",
"interval": 0,
"contract": "string",
"date": "2019-08-24T14:15:22Z",
"amount": 0.1,
"type": "0 = AC",
"category": {"id": 0,
"name": "string",
"type": "0 = Invalid",
"costType": "7534 = None",
"isInternal": true,
"isStrict": true,
"color": 0,
"taxPost": "string",
"syncKey": "string",
"groupId": 0,
"nibuds": [0
],
"group": {"id": 0,
"name": "string",
"type": "0 = Invalid",
"isInternal": true,
"color": 0,
"syncKey": "string",
"categories": [{ }
]
},
"posten": [{"id": 0,
"name": "string",
"description": "string",
"years": [0
]
}
]
},
"nace": {"id": 0,
"code": "string",
"description": "string"
},
"account": {"id": 0,
"country": "string",
"name": "string",
"originalName": "string",
"reference": "string",
"businessId": 0,
"business": {"id": 0,
"name": "string",
"country": "string",
"number": "string",
"subsidiary": "string",
"addresses": [{"id": "string",
"default": true,
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"zipcode": "string",
"city": {"id": "string",
"name": "string"
},
"municipality": {"id": "string",
"name": "string"
},
"province": {"id": "string",
"name": "string"
},
"country": "string",
"type": "string",
"purpose": "0 = Unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0.1,
"longitude": 0.1
}
],
"contacts": [{"type": "0 = Email",
"value": "string"
}
],
"activities": [{"code": "string",
"name": "string",
"isMain": true
}
],
"tradenames": ["string"
]
},
"number": "string",
"formattedNumber": "string",
"iBan": "string",
"bic": "string",
"incassant": "string",
"mandate": "string",
"targetBusinessId": 0,
"targetBusiness": {"id": 0,
"name": "string",
"country": "string",
"number": "string",
"subsidiary": "string",
"addresses": [{"id": "string",
"default": true,
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"zipcode": "string",
"city": {"id": "string",
"name": "string"
},
"municipality": {"id": "string",
"name": "string"
},
"province": {"id": "string",
"name": "string"
},
"country": "string",
"type": "string",
"purpose": "0 = Unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0.1,
"longitude": 0.1
}
],
"contacts": [{"type": "0 = Email",
"value": "string"
}
],
"activities": [{"code": "string",
"name": "string",
"isMain": true
}
],
"tradenames": ["string"
]
},
"targetName": "string"
},
"business": {"id": 0,
"name": "string",
"country": "string",
"number": "string",
"subsidiary": "string",
"addresses": [{"id": "string",
"default": true,
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"zipcode": "string",
"city": {"id": "string",
"name": "string"
},
"municipality": {"id": "string",
"name": "string"
},
"province": {"id": "string",
"name": "string"
},
"country": "string",
"type": "string",
"purpose": "0 = Unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0.1,
"longitude": 0.1
}
],
"contacts": [{"type": "0 = Email",
"value": "string"
}
],
"activities": [{"code": "string",
"name": "string",
"isMain": true
}
],
"tradenames": ["string"
]
},
"name": "string",
"description": "string",
"pattern": "string",
"transactions": [{"id": "string",
"bookDate": "2019-08-24T14:15:22Z",
"interestDate": "2019-08-24T14:15:22Z",
"transactionDate": "2019-08-24T14:15:22Z",
"amount": 0.1,
"count": 0,
"endBalance": 0.1,
"beneficiary": {"id": 0,
"country": "string",
"name": "string",
"originalName": "string",
"reference": "string",
"businessId": 0,
"business": {"id": 0,
"name": "string",
"country": "string",
"number": "string",
"subsidiary": "string",
"addresses": [{"id": null,
"default": null,
"street": null,
"houseNumber": null,
"houseNumberAddition": null,
"zipcode": null,
"city": null,
"municipality": null,
"province": null,
"country": null,
"type": null,
"purpose": null,
"surface": null,
"surfaceArea": null,
"latitude": null,
"longitude": null
}
],
"contacts": [{"type": null,
"value": null
}
],
"activities": [{"code": null,
"name": null,
"isMain": null
}
],
"tradenames": ["string"
]
}
},
"code": {"id": 0,
"type": "0 = AC",
"code": "string",
"numeric": 0,
"name": "string"
},
"description": "string",
"originalDescription": "string",
"flags": "0 = None",
"sequence": 0,
"categoryId": 0,
"category": {"id": 0,
"name": "string",
"type": "0 = Invalid",
"costType": "7534 = None",
"isInternal": true,
"isStrict": true,
"color": 0,
"taxPost": "string",
"syncKey": "string",
"groupId": 0,
"nibuds": [0
],
"group": {"id": 0,
"name": "string",
"type": "0 = Invalid",
"isInternal": true,
"color": 0,
"syncKey": "string",
"categories": [{ }
]
},
"posten": [{"id": 0,
"name": "string",
"description": "string",
"years": [null
]
}
]
},
"naceId": 0,
"nace": {"id": 0,
"code": "string",
"description": "string"
},
"properties": [{"id": 0,
"type": "0 = None",
"context": "0 = Transaction",
"name": "string",
"value": "string",
"properties": [{ }
]
}
],
"contract": "string",
"externalTransactionId": "string",
"inversCategoryId": 0,
"customCategoryId": 0
}
]
}
]
}
]

/api/linx/benchmark

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ClientId	string
InputHash	string

Request Body schema: application/json
required

The file to process

file

Responses

Request samples

Payload

Content type

application/json

null

Response samples

Content type

application/json

[{"id": 0,
"name": "string",
"description": "string",
"contract": "string",
"summary": {"date": "2019-08-24T14:15:22Z",
"bounds": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"days": 0,
"weeks": 0,
"months": 0,
"years": 0,
"isEmpty": true
},
"contract": [{"id": "string",
"externalTransactionId": "string",
"contract": [{ }
],
"bookDate": "2019-08-24T14:15:22Z",
"interestDate": "2019-08-24T14:15:22Z",
"transactionDate": "2019-08-24T14:15:22Z",
"date": "2019-08-24T14:15:22Z",
"amount": 0.1,
"count": 0,
"endBalance": 0.1,
"transactionCode": {"code": "string",
"numeric": 0,
"name": "string",
"type": "0 = AC",
"recurrent": "0 = None"
},
"description": "string",
"originalDescription": "string",
"text": "string",
"beneficiary": {"country": "string",
"name": "string",
"originalName": "string",
"identifier": "string",
"businessId": 0,
"business": {"id": 0,
"countryId": 0,
"country": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [{"id": null,
"codeId": null,
"language": null,
"value": null
}
],
"description": "string"
},
"typeId": 0,
"type": "0 = None",
"registrationId": 0,
"registration": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [{"id": null,
"codeId": null,
"language": null,
"value": null
}
],
"description": "string"
},
"juridicalSituationId": 0,
"juridicalSituation": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [{"id": null,
"codeId": null,
"language": null,
"value": null
}
],
"description": "string"
},
"juridicalFormId": 0,
"juridicalForm": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [{"id": null,
"codeId": null,
"language": null,
"value": null
}
],
"description": "string"
},
"denominationId": 0,
"denomination": {"id": 0,
"businessId": 0,
"typeId": 0,
"type": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [null
],
"description": "string"
},
"languageId": 0,
"language": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [null
],
"description": "string"
},
"name": "string",
"default": true
},
"activityId": 0,
"chainId": 0,
"chain": {"id": 0,
"businessId": 0,
"name": "string",
"typeName": "string",
"assembly": "string",
"lastUpdate": "2019-08-24T14:15:22Z"
},
"addressId": 0,
"number": "string",
"branch": "string",
"dossier": "string",
"subsidiary": "string",
"startDate": "2019-08-24T14:15:22Z",
"active": true,
"activities": [{"id": 0,
"businessId": 0,
"groupId": 0,
"typeId": 0,
"codeId": 0,
"code": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"classificationId": 0,
"classification": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"default": true
}
],
"categories": [{"id": 0,
"businessId": 0,
"codeId": 0,
"categoryId": 0,
"category": {"id": null,
"groupId": null,
"typeId": null,
"costTypeId": null,
"isStrict": null,
"isInternal": null,
"key": null,
"color": null,
"taxPost": null,
"name": null,
"type": null,
"costType": null
},
"applyId": 0,
"applyTo": "0 = None",
"default": true
}
],
"denominations": [{"id": 0,
"businessId": 0,
"typeId": 0,
"type": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"languageId": 0,
"language": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"name": "string",
"default": true
}
],
"addresses": [{"id": 0,
"businessId": 0,
"countryId": 0,
"country": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"languageId": 0,
"typeId": 0,
"type": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"street": "string",
"houseNumber": "string",
"box": "string",
"zipcode": "string",
"city": "string",
"extraInfo": "string",
"latitude": 0.1,
"longitude": 0.1,
"default": true
}
],
"contacts": [{"id": 0,
"businessId": 0,
"typeId": 0,
"type": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"entityId": 0,
"value": "string"
}
]
},
"targetBusinessId": 0,
"targetBusiness": {"id": 0,
"countryId": 0,
"country": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [{"id": null,
"codeId": null,
"language": null,
"value": null
}
],
"description": "string"
},
"typeId": 0,
"type": "0 = None",
"registrationId": 0,
"registration": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [{"id": null,
"codeId": null,
"language": null,
"value": null
}
],
"description": "string"
},
"juridicalSituationId": 0,
"juridicalSituation": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [{"id": null,
"codeId": null,
"language": null,
"value": null
}
],
"description": "string"
},
"juridicalFormId": 0,
"juridicalForm": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [{"id": null,
"codeId": null,
"language": null,
"value": null
}
],
"description": "string"
},
"denominationId": 0,
"denomination": {"id": 0,
"businessId": 0,
"typeId": 0,
"type": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [null
],
"description": "string"
},
"languageId": 0,
"language": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [null
],
"description": "string"
},
"name": "string",
"default": true
},
"activityId": 0,
"chainId": 0,
"chain": {"id": 0,
"businessId": 0,
"name": "string",
"typeName": "string",
"assembly": "string",
"lastUpdate": "2019-08-24T14:15:22Z"
},
"addressId": 0,
"number": "string",
"branch": "string",
"dossier": "string",
"subsidiary": "string",
"startDate": "2019-08-24T14:15:22Z",
"active": true,
"activities": [{"id": 0,
"businessId": 0,
"groupId": 0,
"typeId": 0,
"codeId": 0,
"code": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"classificationId": 0,
"classification": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"default": true
}
],
"categories": [{"id": 0,
"businessId": 0,
"codeId": 0,
"categoryId": 0,
"category": {"id": null,
"groupId": null,
"typeId": null,
"costTypeId": null,
"isStrict": null,
"isInternal": null,
"key": null,
"color": null,
"taxPost": null,
"name": null,
"type": null,
"costType": null
},
"applyId": 0,
"applyTo": "0 = None",
"default": true
}
],
"denominations": [{"id": 0,
"businessId": 0,
"typeId": 0,
"type": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"languageId": 0,
"language": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"name": "string",
"default": true
}
],
"addresses": [{"id": 0,
"businessId": 0,
"countryId": 0,
"country": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"languageId": 0,
"typeId": 0,
"type": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"street": "string",
"houseNumber": "string",
"box": "string",
"zipcode": "string",
"city": "string",
"extraInfo": "string",
"latitude": 0.1,
"longitude": 0.1,
"default": true
}
],
"contacts": [{"id": 0,
"businessId": 0,
"typeId": 0,
"type": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"entityId": 0,
"value": "string"
}
]
},
"denominationId": 0
},
"bankAccount": {"country": "string",
"type": "0 = CodeCategories",
"categoryId": 0,
"naceId": 0,
"applyId": 0
},
"sequence": 0,
"categoryId": 0,
"category": "string",
"inversCategoryId": 0,
"customCategoryId": 0,
"stepsHistory": ["0 = None"
],
"naceId": 0,
"nace": {"id": 0,
"code": "string",
"description": "string"
},
"flags": "0 = None",
"source": null,
"properties": [{"id": 0,
"name": "string",
"displayName": "string",
"type": "0 = None",
"context": "0 = Transaction",
"value": null,
"displayValue": "string"
}
]
}
],
"transactionsTotal": 0,
"transactionsRelevant": 0,
"categorizedTotal": 0,
"categorizedRelevant": 0
},
"result": [{"indicator": {"id": 0,
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"name": "string",
"description": "string",
"includeInternals": true,
"includeTransactions": true,
"threshold": 0.1,
"lowerBound": 0.1,
"upperBound": 0.1,
"implementation": {"missingValuePolicy": "0 = Ignore",
"group": {"id": 0,
"name": "string",
"description": "string"
},
"id": 0,
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"name": "string",
"description": "string",
"includeInternals": true,
"includeTransactions": true,
"threshold": 0.1,
"lowerBound": 0.1,
"upperBound": 0.1,
"implementation": { }
}
},
"group": {"id": 0,
"name": "string",
"description": "string"
},
"isEmpty": true,
"value": {"name": "string",
"value": 0.1,
"unit": "0 = Value",
"year": 0,
"month": 0,
"transactions": [{"id": "string",
"externalTransactionId": "string",
"contract": [{ }
],
"bookDate": "2019-08-24T14:15:22Z",
"interestDate": "2019-08-24T14:15:22Z",
"transactionDate": "2019-08-24T14:15:22Z",
"date": "2019-08-24T14:15:22Z",
"amount": 0.1,
"count": 0,
"endBalance": 0.1,
"transactionCode": {"code": "string",
"numeric": 0,
"name": "string",
"type": "0 = AC",
"recurrent": "0 = None"
},
"description": "string",
"originalDescription": "string",
"text": "string",
"beneficiary": {"country": "string",
"name": "string",
"originalName": "string",
"identifier": "string",
"businessId": 0,
"business": {"id": 0,
"countryId": 0,
"country": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"typeId": 0,
"type": "0 = None",
"registrationId": 0,
"registration": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"juridicalSituationId": 0,
"juridicalSituation": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"juridicalFormId": 0,
"juridicalForm": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"denominationId": 0,
"denomination": {"id": null,
"businessId": null,
"typeId": null,
"type": null,
"languageId": null,
"language": null,
"name": null,
"default": null
},
"activityId": 0,
"chainId": 0,
"chain": {"id": null,
"businessId": null,
"name": null,
"typeName": null,
"assembly": null,
"lastUpdate": null
},
"addressId": 0,
"number": "string",
"branch": "string",
"dossier": "string",
"subsidiary": "string",
"startDate": "2019-08-24T14:15:22Z",
"active": true,
"activities": [null
],
"categories": [null
],
"denominations": [null
],
"addresses": [null
],
"contacts": [null
]
},
"targetBusinessId": 0,
"targetBusiness": {"id": 0,
"countryId": 0,
"country": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"typeId": 0,
"type": "0 = None",
"registrationId": 0,
"registration": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"juridicalSituationId": 0,
"juridicalSituation": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"juridicalFormId": 0,
"juridicalForm": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"denominationId": 0,
"denomination": {"id": null,
"businessId": null,
"typeId": null,
"type": null,
"languageId": null,
"language": null,
"name": null,
"default": null
},
"activityId": 0,
"chainId": 0,
"chain": {"id": null,
"businessId": null,
"name": null,
"typeName": null,
"assembly": null,
"lastUpdate": null
},
"addressId": 0,
"number": "string",
"branch": "string",
"dossier": "string",
"subsidiary": "string",
"startDate": "2019-08-24T14:15:22Z",
"active": true,
"activities": [null
],
"categories": [null
],
"denominations": [null
],
"addresses": [null
],
"contacts": [null
]
},
"denominationId": 0
},
"bankAccount": {"country": "string",
"type": "0 = CodeCategories",
"categoryId": 0,
"naceId": 0,
"applyId": 0
},
"sequence": 0,
"categoryId": 0,
"category": "string",
"inversCategoryId": 0,
"customCategoryId": 0,
"stepsHistory": ["0 = None"
],
"naceId": 0,
"nace": {"id": 0,
"code": "string",
"description": "string"
},
"flags": "0 = None",
"source": null,
"properties": [{"id": 0,
"name": "string",
"displayName": "string",
"type": "0 = None",
"context": "0 = Transaction",
"value": null,
"displayValue": "string"
}
]
}
],
"isEmpty": true
},
"statistics": {"mean": 0.1,
"median": 0.1,
"stdDev": 0.1,
"slope": 0.1,
"observations": 0,
"missingValues": 0
},
"measurements": [{"name": "string",
"value": 0.1,
"unit": "0 = Value",
"year": 0,
"month": 0,
"transactions": [{"id": "string",
"externalTransactionId": "string",
"contract": [{ }
],
"bookDate": "2019-08-24T14:15:22Z",
"interestDate": "2019-08-24T14:15:22Z",
"transactionDate": "2019-08-24T14:15:22Z",
"date": "2019-08-24T14:15:22Z",
"amount": 0.1,
"count": 0,
"endBalance": 0.1,
"transactionCode": {"code": "string",
"numeric": 0,
"name": "string",
"type": "0 = AC",
"recurrent": "0 = None"
},
"description": "string",
"originalDescription": "string",
"text": "string",
"beneficiary": {"country": "string",
"name": "string",
"originalName": "string",
"identifier": "string",
"businessId": 0,
"business": {"id": null,
"countryId": null,
"country": null,
"typeId": null,
"type": null,
"registrationId": null,
"registration": null,
"juridicalSituationId": null,
"juridicalSituation": null,
"juridicalFormId": null,
"juridicalForm": null,
"denominationId": null,
"denomination": null,
"activityId": null,
"chainId": null,
"chain": null,
"addressId": null,
"number": null,
"branch": null,
"dossier": null,
"subsidiary": null,
"startDate": null,
"active": null,
"activities": [ ],
"categories": [ ],
"denominations": [ ],
"addresses": [ ],
"contacts": [ ]
},
"targetBusinessId": 0,
"targetBusiness": {"id": null,
"countryId": null,
"country": null,
"typeId": null,
"type": null,
"registrationId": null,
"registration": null,
"juridicalSituationId": null,
"juridicalSituation": null,
"juridicalFormId": null,
"juridicalForm": null,
"denominationId": null,
"denomination": null,
"activityId": null,
"chainId": null,
"chain": null,
"addressId": null,
"number": null,
"branch": null,
"dossier": null,
"subsidiary": null,
"startDate": null,
"active": null,
"activities": [ ],
"categories": [ ],
"denominations": [ ],
"addresses": [ ],
"contacts": [ ]
},
"denominationId": 0
},
"bankAccount": {"country": "string",
"type": "0 = CodeCategories",
"categoryId": 0,
"naceId": 0,
"applyId": 0
},
"sequence": 0,
"categoryId": 0,
"category": "string",
"inversCategoryId": 0,
"customCategoryId": 0,
"stepsHistory": ["0 = None"
],
"naceId": 0,
"nace": {"id": 0,
"code": "string",
"description": "string"
},
"flags": "0 = None",
"source": null,
"properties": [{"id": null,
"name": null,
"displayName": null,
"type": null,
"context": null,
"value": null,
"displayValue": null
}
]
}
],
"isEmpty": true
}
]
}
]
}
]

/api/linx/ilt

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ClientId	string
InputHash	string

Request Body schema: application/json
required

The file to process

file

Responses

Request samples

Payload

Content type

application/json

null

Response samples

Content type

application/json

[{"id": 0,
"name": "string",
"description": "string",
"contract": "string",
"summary": {"date": "2019-08-24T14:15:22Z",
"bounds": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"days": 0,
"weeks": 0,
"months": 0,
"years": 0,
"isEmpty": true
},
"contract": [{"id": "string",
"externalTransactionId": "string",
"contract": [{ }
],
"bookDate": "2019-08-24T14:15:22Z",
"interestDate": "2019-08-24T14:15:22Z",
"transactionDate": "2019-08-24T14:15:22Z",
"date": "2019-08-24T14:15:22Z",
"amount": 0.1,
"count": 0,
"endBalance": 0.1,
"transactionCode": {"code": "string",
"numeric": 0,
"name": "string",
"type": "0 = AC",
"recurrent": "0 = None"
},
"description": "string",
"originalDescription": "string",
"text": "string",
"beneficiary": {"country": "string",
"name": "string",
"originalName": "string",
"identifier": "string",
"businessId": 0,
"business": {"id": 0,
"countryId": 0,
"country": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [{"id": null,
"codeId": null,
"language": null,
"value": null
}
],
"description": "string"
},
"typeId": 0,
"type": "0 = None",
"registrationId": 0,
"registration": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [{"id": null,
"codeId": null,
"language": null,
"value": null
}
],
"description": "string"
},
"juridicalSituationId": 0,
"juridicalSituation": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [{"id": null,
"codeId": null,
"language": null,
"value": null
}
],
"description": "string"
},
"juridicalFormId": 0,
"juridicalForm": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [{"id": null,
"codeId": null,
"language": null,
"value": null
}
],
"description": "string"
},
"denominationId": 0,
"denomination": {"id": 0,
"businessId": 0,
"typeId": 0,
"type": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [null
],
"description": "string"
},
"languageId": 0,
"language": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [null
],
"description": "string"
},
"name": "string",
"default": true
},
"activityId": 0,
"chainId": 0,
"chain": {"id": 0,
"businessId": 0,
"name": "string",
"typeName": "string",
"assembly": "string",
"lastUpdate": "2019-08-24T14:15:22Z"
},
"addressId": 0,
"number": "string",
"branch": "string",
"dossier": "string",
"subsidiary": "string",
"startDate": "2019-08-24T14:15:22Z",
"active": true,
"activities": [{"id": 0,
"businessId": 0,
"groupId": 0,
"typeId": 0,
"codeId": 0,
"code": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"classificationId": 0,
"classification": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"default": true
}
],
"categories": [{"id": 0,
"businessId": 0,
"codeId": 0,
"categoryId": 0,
"category": {"id": null,
"groupId": null,
"typeId": null,
"costTypeId": null,
"isStrict": null,
"isInternal": null,
"key": null,
"color": null,
"taxPost": null,
"name": null,
"type": null,
"costType": null
},
"applyId": 0,
"applyTo": "0 = None",
"default": true
}
],
"denominations": [{"id": 0,
"businessId": 0,
"typeId": 0,
"type": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"languageId": 0,
"language": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"name": "string",
"default": true
}
],
"addresses": [{"id": 0,
"businessId": 0,
"countryId": 0,
"country": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"languageId": 0,
"typeId": 0,
"type": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"street": "string",
"houseNumber": "string",
"box": "string",
"zipcode": "string",
"city": "string",
"extraInfo": "string",
"latitude": 0.1,
"longitude": 0.1,
"default": true
}
],
"contacts": [{"id": 0,
"businessId": 0,
"typeId": 0,
"type": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"entityId": 0,
"value": "string"
}
]
},
"targetBusinessId": 0,
"targetBusiness": {"id": 0,
"countryId": 0,
"country": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [{"id": null,
"codeId": null,
"language": null,
"value": null
}
],
"description": "string"
},
"typeId": 0,
"type": "0 = None",
"registrationId": 0,
"registration": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [{"id": null,
"codeId": null,
"language": null,
"value": null
}
],
"description": "string"
},
"juridicalSituationId": 0,
"juridicalSituation": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [{"id": null,
"codeId": null,
"language": null,
"value": null
}
],
"description": "string"
},
"juridicalFormId": 0,
"juridicalForm": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [{"id": null,
"codeId": null,
"language": null,
"value": null
}
],
"description": "string"
},
"denominationId": 0,
"denomination": {"id": 0,
"businessId": 0,
"typeId": 0,
"type": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [null
],
"description": "string"
},
"languageId": 0,
"language": {"id": 0,
"country": "string",
"categoryId": 0,
"name": "string",
"values": [null
],
"description": "string"
},
"name": "string",
"default": true
},
"activityId": 0,
"chainId": 0,
"chain": {"id": 0,
"businessId": 0,
"name": "string",
"typeName": "string",
"assembly": "string",
"lastUpdate": "2019-08-24T14:15:22Z"
},
"addressId": 0,
"number": "string",
"branch": "string",
"dossier": "string",
"subsidiary": "string",
"startDate": "2019-08-24T14:15:22Z",
"active": true,
"activities": [{"id": 0,
"businessId": 0,
"groupId": 0,
"typeId": 0,
"codeId": 0,
"code": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"classificationId": 0,
"classification": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"default": true
}
],
"categories": [{"id": 0,
"businessId": 0,
"codeId": 0,
"categoryId": 0,
"category": {"id": null,
"groupId": null,
"typeId": null,
"costTypeId": null,
"isStrict": null,
"isInternal": null,
"key": null,
"color": null,
"taxPost": null,
"name": null,
"type": null,
"costType": null
},
"applyId": 0,
"applyTo": "0 = None",
"default": true
}
],
"denominations": [{"id": 0,
"businessId": 0,
"typeId": 0,
"type": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"languageId": 0,
"language": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"name": "string",
"default": true
}
],
"addresses": [{"id": 0,
"businessId": 0,
"countryId": 0,
"country": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"languageId": 0,
"typeId": 0,
"type": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"street": "string",
"houseNumber": "string",
"box": "string",
"zipcode": "string",
"city": "string",
"extraInfo": "string",
"latitude": 0.1,
"longitude": 0.1,
"default": true
}
],
"contacts": [{"id": 0,
"businessId": 0,
"typeId": 0,
"type": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"entityId": 0,
"value": "string"
}
]
},
"denominationId": 0
},
"bankAccount": {"country": "string",
"type": "0 = CodeCategories",
"categoryId": 0,
"naceId": 0,
"applyId": 0
},
"sequence": 0,
"categoryId": 0,
"category": "string",
"inversCategoryId": 0,
"customCategoryId": 0,
"stepsHistory": ["0 = None"
],
"naceId": 0,
"nace": {"id": 0,
"code": "string",
"description": "string"
},
"flags": "0 = None",
"source": null,
"properties": [{"id": 0,
"name": "string",
"displayName": "string",
"type": "0 = None",
"context": "0 = Transaction",
"value": null,
"displayValue": "string"
}
]
}
],
"transactionsTotal": 0,
"transactionsRelevant": 0,
"categorizedTotal": 0,
"categorizedRelevant": 0
},
"result": [{"indicator": {"id": 0,
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"name": "string",
"description": "string",
"includeInternals": true,
"includeTransactions": true,
"threshold": 0.1,
"lowerBound": 0.1,
"upperBound": 0.1,
"implementation": {"missingValuePolicy": "0 = Ignore",
"group": {"id": 0,
"name": "string",
"description": "string"
},
"id": 0,
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"name": "string",
"description": "string",
"includeInternals": true,
"includeTransactions": true,
"threshold": 0.1,
"lowerBound": 0.1,
"upperBound": 0.1,
"implementation": { }
}
},
"group": {"id": 0,
"name": "string",
"description": "string"
},
"isEmpty": true,
"value": {"name": "string",
"value": 0.1,
"unit": "0 = Value",
"year": 0,
"month": 0,
"transactions": [{"id": "string",
"externalTransactionId": "string",
"contract": [{ }
],
"bookDate": "2019-08-24T14:15:22Z",
"interestDate": "2019-08-24T14:15:22Z",
"transactionDate": "2019-08-24T14:15:22Z",
"date": "2019-08-24T14:15:22Z",
"amount": 0.1,
"count": 0,
"endBalance": 0.1,
"transactionCode": {"code": "string",
"numeric": 0,
"name": "string",
"type": "0 = AC",
"recurrent": "0 = None"
},
"description": "string",
"originalDescription": "string",
"text": "string",
"beneficiary": {"country": "string",
"name": "string",
"originalName": "string",
"identifier": "string",
"businessId": 0,
"business": {"id": 0,
"countryId": 0,
"country": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"typeId": 0,
"type": "0 = None",
"registrationId": 0,
"registration": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"juridicalSituationId": 0,
"juridicalSituation": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"juridicalFormId": 0,
"juridicalForm": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"denominationId": 0,
"denomination": {"id": null,
"businessId": null,
"typeId": null,
"type": null,
"languageId": null,
"language": null,
"name": null,
"default": null
},
"activityId": 0,
"chainId": 0,
"chain": {"id": null,
"businessId": null,
"name": null,
"typeName": null,
"assembly": null,
"lastUpdate": null
},
"addressId": 0,
"number": "string",
"branch": "string",
"dossier": "string",
"subsidiary": "string",
"startDate": "2019-08-24T14:15:22Z",
"active": true,
"activities": [null
],
"categories": [null
],
"denominations": [null
],
"addresses": [null
],
"contacts": [null
]
},
"targetBusinessId": 0,
"targetBusiness": {"id": 0,
"countryId": 0,
"country": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"typeId": 0,
"type": "0 = None",
"registrationId": 0,
"registration": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"juridicalSituationId": 0,
"juridicalSituation": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"juridicalFormId": 0,
"juridicalForm": {"id": null,
"country": null,
"categoryId": null,
"name": null,
"values": [ ],
"description": null
},
"denominationId": 0,
"denomination": {"id": null,
"businessId": null,
"typeId": null,
"type": null,
"languageId": null,
"language": null,
"name": null,
"default": null
},
"activityId": 0,
"chainId": 0,
"chain": {"id": null,
"businessId": null,
"name": null,
"typeName": null,
"assembly": null,
"lastUpdate": null
},
"addressId": 0,
"number": "string",
"branch": "string",
"dossier": "string",
"subsidiary": "string",
"startDate": "2019-08-24T14:15:22Z",
"active": true,
"activities": [null
],
"categories": [null
],
"denominations": [null
],
"addresses": [null
],
"contacts": [null
]
},
"denominationId": 0
},
"bankAccount": {"country": "string",
"type": "0 = CodeCategories",
"categoryId": 0,
"naceId": 0,
"applyId": 0
},
"sequence": 0,
"categoryId": 0,
"category": "string",
"inversCategoryId": 0,
"customCategoryId": 0,
"stepsHistory": ["0 = None"
],
"naceId": 0,
"nace": {"id": 0,
"code": "string",
"description": "string"
},
"flags": "0 = None",
"source": null,
"properties": [{"id": 0,
"name": "string",
"displayName": "string",
"type": "0 = None",
"context": "0 = Transaction",
"value": null,
"displayValue": "string"
}
]
}
],
"isEmpty": true
},
"statistics": {"mean": 0.1,
"median": 0.1,
"stdDev": 0.1,
"slope": 0.1,
"observations": 0,
"missingValues": 0
},
"measurements": [{"name": "string",
"value": 0.1,
"unit": "0 = Value",
"year": 0,
"month": 0,
"transactions": [{"id": "string",
"externalTransactionId": "string",
"contract": [{ }
],
"bookDate": "2019-08-24T14:15:22Z",
"interestDate": "2019-08-24T14:15:22Z",
"transactionDate": "2019-08-24T14:15:22Z",
"date": "2019-08-24T14:15:22Z",
"amount": 0.1,
"count": 0,
"endBalance": 0.1,
"transactionCode": {"code": "string",
"numeric": 0,
"name": "string",
"type": "0 = AC",
"recurrent": "0 = None"
},
"description": "string",
"originalDescription": "string",
"text": "string",
"beneficiary": {"country": "string",
"name": "string",
"originalName": "string",
"identifier": "string",
"businessId": 0,
"business": {"id": null,
"countryId": null,
"country": null,
"typeId": null,
"type": null,
"registrationId": null,
"registration": null,
"juridicalSituationId": null,
"juridicalSituation": null,
"juridicalFormId": null,
"juridicalForm": null,
"denominationId": null,
"denomination": null,
"activityId": null,
"chainId": null,
"chain": null,
"addressId": null,
"number": null,
"branch": null,
"dossier": null,
"subsidiary": null,
"startDate": null,
"active": null,
"activities": [ ],
"categories": [ ],
"denominations": [ ],
"addresses": [ ],
"contacts": [ ]
},
"targetBusinessId": 0,
"targetBusiness": {"id": null,
"countryId": null,
"country": null,
"typeId": null,
"type": null,
"registrationId": null,
"registration": null,
"juridicalSituationId": null,
"juridicalSituation": null,
"juridicalFormId": null,
"juridicalForm": null,
"denominationId": null,
"denomination": null,
"activityId": null,
"chainId": null,
"chain": null,
"addressId": null,
"number": null,
"branch": null,
"dossier": null,
"subsidiary": null,
"startDate": null,
"active": null,
"activities": [ ],
"categories": [ ],
"denominations": [ ],
"addresses": [ ],
"contacts": [ ]
},
"denominationId": 0
},
"bankAccount": {"country": "string",
"type": "0 = CodeCategories",
"categoryId": 0,
"naceId": 0,
"applyId": 0
},
"sequence": 0,
"categoryId": 0,
"category": "string",
"inversCategoryId": 0,
"customCategoryId": 0,
"stepsHistory": ["0 = None"
],
"naceId": 0,
"nace": {"id": 0,
"code": "string",
"description": "string"
},
"flags": "0 = None",
"source": null,
"properties": [{"id": null,
"name": null,
"displayName": null,
"type": null,
"context": null,
"value": null,
"displayValue": null
}
]
}
],
"isEmpty": true
}
]
}
]
}
]

/api/linx/indicator/consumer

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ClientId	string
InputHash	string
KvK	string
SBI	string
ReportingPeriod	string <json> Example: {"PeriodUnit": "month","FullPeriodsOnly": true}
DateRange	string <json> Example: {"DateFrom": "2019-01-01","DateTo": "2020-01-01"}

Responses

Response samples

Content type

application/json

{"indicators": [{"name": "string"
}
],
"isEmpty": true
}

/api/linx/indicator/business

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ClientId	string
InputHash	string
KvK	string
SBI	string
ReportingPeriod	string <json> Example: {"PeriodUnit": "month","FullPeriodsOnly": true}
DateRange	string <json> Example: {"DateFrom": "2019-01-01","DateTo": "2020-01-01"}

Responses

Response samples

Content type

application/json

{"indicators": [{"name": "string"
}
],
"isEmpty": true
}

/api/v1/LinX/recurrence

header Parameters

ApiKey required	any
X-Request-ID required	string <uuid>
ClientId	string
InputHash	string
Options	integer

Request Body schema: application/json
required

The file to process

file

Responses

Request samples

Payload

Content type

application/json

null

Response samples

Content type

application/json

{"accountsCount": 0,
"recurrenceCategoriesCount": 0,
"recurrenceContractsCount": 0,
"recurrenceTransactionsCount": 0,
"totalRecurrenceIncome": 0.1,
"monthlyRecurrenceIncome": 0.1,
"totalRecurrenceExpense": 0.1,
"monthlyRecurrenceExpense": 0.1,
"accounts": [{"account": {"country": "string",
"name": "string",
"originalName": "string",
"identifier": "string",
"denominationId": 0,
"swiftCode": "string",
"bank": "string",
"number": "string",
"formatted": "string",
"iBan": "string",
"beginBalanceDate": "2019-08-24T14:15:22Z",
"beginBalance": 0.1,
"endBalanceDate": "2019-08-24T14:15:22Z",
"endBalance": 0.1
},
"totalRecurrenceIncome": 0.1,
"monthlyRecurrenceIncome": 0.1,
"totalRecurrenceExpense": 0.1,
"monthlyRecurrenceExpense": 0.1,
"recurrenceCategoriesCount": 0,
"recurrenceContractsCount": 0,
"recurrenceTransactionsCount": 0,
"recurrences": [{"categoryId": 0,
"categoryName": "string",
"contractsCount": 0,
"transactionsCount": 0,
"totalAmount": 0.1,
"monthlyAmount": 0.1,
"contracts": [{"beneficiary": {"country": "string",
"name": "string",
"originalName": "string",
"identifier": "string",
"denominationId": 0
},
"recurrenceProperties": {"quality": 0.1,
"periodUnit": "0 = None",
"period": 0
},
"totalAmount": 0.1,
"monthlyAmount": 0.1,
"firstTransactionDate": "2019-08-24T14:15:22Z",
"lastTransactionDate": "2019-08-24T14:15:22Z",
"transactionsCount": 0,
"transactions": [{"bookDate": "2019-08-24T14:15:22Z",
"interestDate": "2019-08-24T14:15:22Z",
"transactionDate": "2019-08-24T14:15:22Z",
"amount": 0.1,
"description": "string",
"originalDescription": "string",
"externalTransactionId": "string"
}
]
}
]
}
],
"anomaliesTransactionsCount": 0,
"anomalies": [{"categoryId": 0,
"categoryName": "string",
"contractsCount": 0,
"transactionsCount": 0,
"totalAmount": 0.1,
"monthlyAmount": 0.1,
"contracts": [{"beneficiary": {"country": "string",
"name": "string",
"originalName": "string",
"identifier": "string",
"denominationId": 0
},
"recurrenceProperties": {"quality": 0.1,
"periodUnit": "0 = None",
"period": 0
},
"totalAmount": 0.1,
"monthlyAmount": 0.1,
"firstTransactionDate": "2019-08-24T14:15:22Z",
"lastTransactionDate": "2019-08-24T14:15:22Z",
"transactionsCount": 0,
"transactions": [{"bookDate": "2019-08-24T14:15:22Z",
"interestDate": "2019-08-24T14:15:22Z",
"transactionDate": "2019-08-24T14:15:22Z",
"amount": 0.1,
"description": "string",
"originalDescription": "string",
"externalTransactionId": "string"
}
]
}
]
}
]
}
]
}

LinX API (Deprecated)

Consents

/api/v1/Consents/generateConsentWizardUrl

path Parameters

query Parameters

header Parameters

Responses

Response samples

/api/v1/Consents/generateUrl

path Parameters

query Parameters

header Parameters

Responses

Response samples

/api/v1/Consents/info

path Parameters

query Parameters

header Parameters

Responses

Response samples

/api/v1/Consents/accounts

path Parameters

query Parameters

header Parameters

Responses

Response samples

/api/v1/Consents/clearCollection

path Parameters

query Parameters

header Parameters

Responses

Response samples

Status

/api/v1/Status/BankHealth

path Parameters

header Parameters

Responses

Response samples

LinX

/api/linx/convert

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

/api/linx/banks

header Parameters

Responses

Response samples

/api/linx/categories

header Parameters

Responses

Response samples

/api/linx/groups

header Parameters

Responses

Response samples

/api/linx/paymentcodes

header Parameters

Responses

Response samples

/api/linx/costtypes

header Parameters

Responses

Response samples

/api/linx/countries

header Parameters

Responses

Response samples

/api/linx/nibudmodel

header Parameters

Responses

Response samples

/api/linx/pivot

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

/api/linx/pivotgroup

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required