Company rest API
Paydex
The API returns company's current paydex and history information in JSON format, as specified by business id or duns number.
In order to use the API you must have the valid environment-specific username and password. Before any API requests, you need to obtain an API KEY. You will get a valid API KEY (it's called a ticket) by using the ticket API (Please, read how to use ticket API instructions).
The API KEY must be sent in the request custom header element (named ticket or x-api-key). If the API KEY value is valid then API request will be successful (http status code 200), otherwise it will fail (http status code 401). All API requests must be made over HTTPS.
API endpoints
- https://api.bisnode.fi/company/info/v2/paydex - production environment
- https://api-test.bisnode.fi/company/info/v2/paydex - test environment
API request parameters
| Parameter | Description | |
|---|---|---|
| id | Business id or duns number | X |
| X = Mandatory | ||
GET https://api-test.bisnode.fi/company/info/v2/paydex/{id}
API response
| Element | Description |
|---|---|
| businessId | The company's business id. e.g. 2014838-7 |
| dunsNumber | The company's duns number. e.g. 539506084 |
| averageDelay | Avarange delay. e.g. 2 |
| paydex | Paydex. e.g. 75 |
| totalAmount | Total amount. e.g. 30613 |
| numberOfInvoices | Number of invoices. e.g. 13 |
| numberOfSuppliers | Number of suppliers. e.g. 3 |
| calculationDate | Date of calculation. e.g. 2018-02-11T03:00:00.803Z |
| paydexAll | All paydex. e.g. 75 |
| paydexLoB | LoB paydex. e.g. 74 |
| orderBy | Order by. e.g. 1 |
API request and response example
curl 'https://api-test.bisnode.fi/company/info/v2/paydex/2014838-7' -H 'x-api-key: 1234567890ABC'
Successful request and the API return results in JSON format.
{
"businessId": "2014838-7",
"dunsNumber": "539506084",
"paydex": {
"averageDelay": 2,
"paydex": 75,
"totalAmount": 30613,
"numberOfInvoices": 13,
"numberOfSuppliers": 3,
"calculationDate": "2018-02-11T03:00:00.803Z",
"paydexAll": 75,
"paydexLoB": 74,
"orderBy": 1
},
"paydexHistory": [
{
"averageDelay": 2,
"paydex": 75,
"totalAmount": 30613,
"numberOfInvoices": 13,
"numberOfSuppliers": 3,
"calculationDate": "2018-02-04T03:00:00.913Z",
"paydexAll": 75,
"paydexLoB": 74,
"orderBy": 2
}
]
}
Please note that data coverage varies between companies. Data coverage depends e.g. on company form. Remember the codes and descriptions API returns all companies REST APIs code values and descriptions - read more.