Periodical income service
The Periodical income service has been designed to predict fixed and regular income. Among other things this contains:
- Salary/benefits (various breadwinners, various employers)
- Taxes (periodical returns, etc.)
- Allowances (child support, etc.)
- Alimony, retirement fund, student grants, etc.
- Transactions of other (internal) accounts
Calling the Periodical Income Service
Endpoint: https://linx.invers.nl:8100/api/linx/periodical_income
Method: POST
Header: ApiKey: string (required)
X-Request-ID: string (required)
ClientId: string (optional)
InputHash: string (optional)
Options: int (optional) (default = 33)
Body: Data: byte[] (required)
Errors: 400, 403 or 500
Information
| Field | Type | Description |
|---|---|---|
| account | string | Bank account |
| items | Array van items | Periodical income |
Account
| Field | Type | Description |
|---|---|---|
| number | String | Bank account number without layout formatting |
| formattedNumber | String | Bank account number with layout formatting |
| iban | String | IBAN |
| bic | String | BIC |
| beginBalanceDate | Date | Date of opening balance |
| beginBalance | Decimal | Value of opening balance |
| endBalanceDate | Date | Date of closing balance |
| endBalance | Decimal | Value of closing balance |
| country | String | Country code in ISO 2 characters |
Items
| Field | Type | Description |
|---|---|---|
| probability | Enum | Low Medium High |
| frequencyType | Enum | None Daily Weekly Monthly Yearly |
| interval | Integer | Interval of recurrency (i.e. 3 months) |
| contract | String | IBAN |
| date | Date | Date of recurrence |
| amount | Decimal | |
| type | String | Payment code |
| category | Category | Category |
| account | String | [Contra Account](#Contra Account) |
| name | String | Name |
| pattern | String | Internal parameter |
| transactions | Array of transactions | Transactions |
Category
| Field | Type | Description |
|---|---|---|
| id | Integer | Category identifier |
| name | String | Category name |
| type | Enum | None Income Expenses |
| costType | None Fix Variable | |
| isInternal | Boolean | True if it is an internal transaction |
| isStrict | Boolean | Internal Parameter |
| color | Integer | Internal parameter |
| taxpost | String | Taxpost |
| SyncKey | UUID | Internal Parameter |
| groupId | Group | Group identifier to which the category belongs |
Contra Account
| Field | Type | Description |
|---|---|---|
| number | String | Bank account number |
| formattedNumber | String | Bank account number with layout formatting |
| iban | String | IBAN |
| incassant | String | Collection identifier |
| mandate | String | Collection mandate |
| id | Integer | Internal parameter |
| country | String | Country code ISO 2 characters |
| name | String | name of contra account |
| originalName | String | Original name of the contra account |
| reference | String | Mutation reference |
| businessId | Integer | Business identifier of the counterpart. Can be empty. |
Transactions
| Field | Type | Description |
|---|---|---|
| bookDate | Date | Book date |
| interestDate | Date | Interest date |
| amount | Decimal | Amount of mutation |
| endBalance | Decimal | End balance |
| beneficiary | Beneficiary | Counterpart of the mutation |
| code | TransactionCode | Mutation type, see Properties and transaction types |
| description | String | Detected description of the transaction |
| originaldescription | String | Orginal, unrefined, description |
| flags | Flags | Internal parameter |
| sequence | Integer | serial number |
Beneficiary
| Field | Type | Description |
|---|---|---|
| number | String | Bank account number without layout formatting |
| formattedNumber | String | Bank account number with layout formatting |
| iban | String | IBAN |
| incassant | String | Identity in case of collection |
| mandate | String | Collection mandate |
| targetBusinessId | Integer | Identity of the real counterpart (in case of a payment service such as iDeal) |
| id | Integer | Internal parameter |
| country | String | Country code ISO 2 characters |
| name | String | Name Counterpart |
| originalName | String | Original, unrefined, name of counterpart |
| reference | String | Reference of the transaction |
| businessId | Integer | Business identifier of the counterpart, may be empty |
Business
| Field | Type | Description |
|---|---|---|
| id | Integer | Counterpart identifier |
| name | String | Name of counterpart |
| country | String | Country code ISO 2 characters |
| number | String | Chamber of Commerce (KvK) number |
| tradenames | Array |
Output (example)
[
{
"account": {
"iban": "string",
"bic": "string",
"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": "unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0,
"longitude": 0
}
],
"contacts": [
{
"type": "email",
"value": "string"
}
],
"activities": [
{
"code": "string",
"name": "string",
"isMain": true
}
],
"tradenames": [
"string"
]
},
"number": "string",
"formattedNumber": "string",
"beginBalanceDate": "YYYY-MM-DDTHH:MM:SS+HH:MM",
"beginBalance": 0,
"endBalanceDate": "YYYY-MM-DDTHH:MM:SS+HH:MM",
"endBalance": 0,
"transactions": [
{
"id": "string",
"bookDate": "YYYY-MM-DDTHH:MM:SS+HH:MM",
"interestDate": "YYYY-MM-DDTHH:MM:SS+HH:MM",
"amount": 0,
"endBalance": 0,
"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": "string",
"name": "string"
},
"municipality": {
"id": "string",
"name": "string"
},
"province": {
"id": "string",
"name": "string"
},
"country": "string",
"type": "string",
"purpose": "unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0,
"longitude": 0
}
],
"contacts": [
{
"type": "email",
"value": "string"
}
],
"activities": [
{
"code": "string",
"name": "string",
"isMain": true
}
],
"tradenames": [
"string"
]
}
},
"code": {
"id": 0,
"type": "aC",
"code": "string",
"numeric": 0,
"name": "string"
},
"description": "string",
"originalDescription": "string",
"flags": "none",
"sequence": 0,
"categoryId": 0,
"category": {
"id": 0,
"name": "string",
"type": "none",
"costType": "none",
"isInternal": true,
"isStrict": true,
"color": 0,
"taxPost": "string",
"syncKey": "string",
"groupId": 0,
"nibuds": [
0
],
"group": {
"id": 0,
"name": "string",
"type": "none",
"isInternal": true,
"color": 0,
"syncKey": "string",
"categories": [
null
]
},
"posten": [
{
"id": 0,
"name": "string",
"description": "string",
"years": [
0
]
}
]
},
"naceId": 0,
"nace": {
"id": 0,
"code": "string",
"description": "string"
},
"properties": [
{
"id": 0,
"type": "none",
"context": "transaction",
"name": "string",
"value": "string",
"properties": [
null
]
}
],
"contract": "string"
}
]
},
"items": [
{
"probability": "medium",
"frequenceType": "none",
"interval": 0,
"contract": "string",
"date": "YYYY-MM-DDTHH:MM:SS+HH:MM",
"amount": 0,
"type": "aC",
"category": {
"id": 0,
"name": "string",
"type": "none",
"costType": "none",
"isInternal": true,
"isStrict": true,
"color": 0,
"taxPost": "string",
"syncKey": "string",
"groupId": 0,
"nibuds": [
0
],
"group": {
"id": 0,
"name": "string",
"type": "none",
"isInternal": true,
"color": 0,
"syncKey": "string",
"categories": [
null
]
},
"posten": [
{
"id": 0,
"name": "string",
"description": "string",
"years": [
0
]
}
]
},
"nace": {
"id": 0,
"code": "string",
"description": "string"
},
"account": {
"iban": "string",
"bic": "string",
"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": "unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0,
"longitude": 0
}
],
"contacts": [
{
"type": "email",
"value": "string"
}
],
"activities": [
{
"code": "string",
"name": "string",
"isMain": true
}
],
"tradenames": [
"string"
]
},
"number": "string",
"formattedNumber": "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": "unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0,
"longitude": 0
}
],
"contacts": [
{
"type": "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": "unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0,
"longitude": 0
}
],
"contacts": [
{
"type": "email",
"value": "string"
}
],
"activities": [
{
"code": "string",
"name": "string",
"isMain": true
}
],
"tradenames": [
"string"
]
},
"name": "string",
"description": "string",
"pattern": "string",
"transactions": [
{
"id": "string",
"bookDate": "YYYY-MM-DDTHH:MM:SS+HH:MM",
"interestDate": "YYYY-MM-DDTHH:MM:SS+HH:MM",
"amount": 0,
"endBalance": 0,
"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": "string",
"name": "string"
},
"municipality": {
"id": "string",
"name": "string"
},
"province": {
"id": "string",
"name": "string"
},
"country": "string",
"type": "string",
"purpose": "unknown",
"surface": 0,
"surfaceArea": 0,
"latitude": 0,
"longitude": 0
}
],
"contacts": [
{
"type": "email",
"value": "string"
}
],
"activities": [
{
"code": "string",
"name": "string",
"isMain": true
}
],
"tradenames": [
"string"
]
}
},
"code": {
"id": 0,
"type": "aC",
"code": "string",
"numeric": 0,
"name": "string"
},
"description": "string",
"originalDescription": "string",
"flags": "none",
"sequence": 0,
"categoryId": 0,
"category": {
"id": 0,
"name": "string",
"type": "none",
"costType": "none",
"isInternal": true,
"isStrict": true,
"color": 0,
"taxPost": "string",
"syncKey": "string",
"groupId": 0,
"nibuds": [
0
],
"group": {
"id": 0,
"name": "string",
"type": "none",
"isInternal": true,
"color": 0,
"syncKey": "string",
"categories": [
null
]
},
"posten": [
{
"id": 0,
"name": "string",
"description": "string",
"years": [
0
]
}
]
},
"naceId": 0,
"nace": {
"id": 0,
"code": "string",
"description": "string"
},
"properties": [
{
"id": 0,
"type": "none",
"context": "transaction",
"name": "string",
"value": "string",
"properties": [
null
]
}
],
"contract": "string"
}
]
}
]
}
]