Inyett API / Company Control
Company Control
Description
Inyett 'Company Control' validates an organisation number and creates a rating of the company(Green/Yellow/Red) . A scenario where It would be good to do a health check of a company is when adding a new supplier in the ERP system.
Datasets
Name | Description | Endpoint |
Control / Main rating | Endpoint for all company controls. | GET /3/{profileCountry}/control/companies/{orgNr}/main-rating |
Main rating for a Company
Method: GET
Path Parameters
Name | Type | Required | Description |
country | string | True | Country of the company (NO or SE) |
orgNr | string | True | Organisationsnummer of the company to Control |
showAllChecks | string | False | Only deliver Default value: False |
languageCode | string | False | Description values (SV, NO, EN) |
RESPONS
Field name |
Type |
Scope |
Description (EN) |
level | string | SE/NO | Color of the main rating of the company |
Observation |
list [] object | SE/NO | |
level | string | Color of the rating for category 'Observation' | |
indications | list [] object | List of control codes | |
key | string | Control code | |
name | string | Name of the control | |
description | string | Description of control | |
Remarks | list [] object | SE/NO | |
level | string | Color of the rating for category 'Remarks' | |
indications | list [] object | List of control codes | |
key | string | Control code | |
name | string | Name of the control | |
description | string | Description of control | |
Finance | list [] object | SE/NO | |
level | string | Color of the rating for category 'Finance' | |
indications | list [] object | List of control codes | |
key | string | Control code | |
name | string | Name of the control | |
description | string | Description of control | |
Fraud | list [] object | SE/NO | |
level | string | Color of the rating for category 'Fraud' | |
indications | list [] object | List of control codes | |
key | string | Control code | |
name | string | Name of the control | |
description | string | Description of control | |
debtRating | list [] object | SE | |
level | string | Color of the rating for category 'debtRating' | |
indications | list [] object | List of control codes | |
key | string | Control code | |
name | string | Name of the control | |
description | string | Description of control | |
Sanctions | list [] object | SE/NO | |
level | string | Color of the rating for category 'Sanctions' | |
indications | list [] object | List of control codes | |
key | string | Control code | |
name | string | Name of the control | |
description | string | Description of control |
User Story: Automated supplier validation and assessment
As a procurement manager
I want to utilize Inyett 'Company Control' to automate the validation and rating of potential new suppliers
So that I can ensure their credibility and financial health before adding them to our ERP system.
Acceptance Criteria
1. Validate and assess a potential new supplier:
- Given I have an organization number for a potential new supplier,
- When I perform a GET request to
/2/{country}/control/companies/{orgNr}/main-rating
, - Then I expect to receive a main rating (Green/Yellow/Red) based on a comprehensive analysis of the company’s financial and legal standing.
2. Retrieve detailed information on observations:
- Given a main rating has been generated,
- When I review the response from the API,
- Then I want to see detailed information about specific observations, remarks, financial indicators, fraud risks, debt ratings, and sanctions lists that influenced the rating.
3. Customize response data based on language and checks scope:
- Given I have specific requirements for the information I need,
- When I send my request,
- Then I want to be able to specify a
languageCode
(for language) andshowAllChecks
(to decide if I want to see all checks or just those that influenced the main rating) as parameters to tailor the response I receive.
Buisness Value
This automated process for validating and assessing new suppliers offers a fast and efficient way to:
- Minimize Risk: Ensures the company only engages with financially and legally sound suppliers.
- Increase Efficiency: Eliminates manual work and time-consuming background research of suppliers.
- Enhance the Company’s Reputation: Contributes to ethical and legal compliance by avoiding suppliers with potential financial problems or sanctions.
By implementing this integration, the company can not only secure its supply chains but also optimize its selection of new suppliers with high precision and confidence.