Control

Company monitoring

Search companies in control

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

govidstringRequired

Business Id

Responses

200

successful operation

application/json

Control

controlIdintegerOptionalExample: 2000015

govIdstringOptionalExample: 1234567-8

startTimestringOptionalExample: 2017-02-09T13:07:00+02:00

controlNamestringOptionalExample: Yritys Oy

statusCodestringOptionalExample: 2

statusTextstringOptionalExample: Waiting activation

404

Not found

application/json

get

/control/incontrol/{govid}

HTTPcURLJavaScriptPython

GET /rest/control/incontrol/{govid} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "controlId": "2000015",
    "govId": "1234567-8",
    "startTime": "2017-02-09T13:07:00+02:00",
    "controlName": "Yritys Oy",
    "statusCode": "2",
    "statusText": "Waiting activation"
  }
]

Add company to control

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

govidstringRequired

Business Id

Responses

201

Successful operation

application/json

400

Bad request

application/json

404

Not found

application/json

409

Conflict

application/json

post

/control/incontrol/{govid}

HTTPcURLJavaScriptPython

POST /rest/control/incontrol/{govid} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "controlId": "2000000",
  "govId": "1234567-8",
  "startTime": "2017-02-09T13:07:00+02:00",
  "controlName": "Yritys Oy",
  "statusCode": "2",
  "statusText": "Waiting activation"
}

Delete company from control

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

govidstringRequired

Business id

Responses

204

Control disabled

400

Bad request

application/json

404

Not found

application/json

delete

/control/incontrol/{govid}

HTTPcURLJavaScriptPython

DELETE /rest/control/incontrol/{govid} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Search reports by businessid

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

govidstringRequired

Business Id

Responses

200

successful operation

application/json

ControlReport

reportIdintegerOptionalExample: 123

controlIdintegerOptionalExample: 2000000

govIdstringOptionalExample: 1234567-8

controlNamestringOptionalExample: Yritys Oy

datetimestringOptionalExample: 2017-02-09T13:07:00+02:00

400

Not found

application/json

404

Bad request

application/json

get

/control/reportsbygovid/{govid}

HTTPcURLJavaScriptPython

GET /rest/control/reportsbygovid/{govid} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "reportId": "123",
    "controlId": "2000000",
    "govId": "1234567-8",
    "controlName": "Yritys Oy",
    "datetime": "2017-02-09T13:07:00+02:00"
  }
]

Search reports by date

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

datestringRequired

Report date

Responses

200

successful operation

application/json

ControlReport

reportIdintegerOptionalExample: 123

controlIdintegerOptionalExample: 2000000

govIdstringOptionalExample: 1234567-8

controlNamestringOptionalExample: Yritys Oy

datetimestringOptionalExample: 2017-02-09T13:07:00+02:00

400

Bad request

application/json

404

Not found

application/json

get

/control/reportsbydate/{date}

HTTPcURLJavaScriptPython

GET /rest/control/reportsbydate/{date} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "reportId": "123",
    "controlId": "2000000",
    "govId": "1234567-8",
    "controlName": "Yritys Oy",
    "datetime": "2017-02-09T13:07:00+02:00"
  }
]

Get report

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

reportidintegerRequired

Id of report

Responses

200

successfull operation

application/json

ControlReportResponse

reportIdintegerOptionalExample: 123

controlIdintegerOptionalExample: 2000000

timestampstringOptionalExample: 2017-02-09T13:07:00+02:00

control_govidstringOptionalExample: 1234567-8

control_namestringOptionalExample: Yritys Oy

control_ratingstringOptionalExample: A

control_paydexstringOptionalExample: 70

control_ratingdatestringOptionalExample: 2017-02-09

control_scoringchangestringOptional

control_ratingchangestringOptionalExample: RAT

control_namechangestringOptionalExample: NIM

control_newpaymentfaultstringOptionalExample: MHA

control_newaccountingdetailsstringOptionalExample: TIL

control_companydelstringOptionalExample: LAK

control_fusionstringOptionalExample: FUU

control_eprstringOptionalExample: EPR

control_prevratingstringOptionalExample: C

control_dunsstringOptionalExample: 123456789

control_receivinggovidstringOptionalExample: 1234567-8

control_scorestringOptionalExample: 80

control_payment_code1stringOptionalExample: YVK

control_payment_date1stringOptionalExample: 2017-02-09

control_payment_amount1integerOptionalExample: 10

control_payment_ref1stringOptional

control_payment_receiver1stringOptionalExample: Yritys Oy

control_payment_code2stringOptionalExample: YVK

control_payment_date2stringOptionalExample: 2017-02-09

control_payment_amount2integerOptionalExample: 10

control_payment_ref2stringOptional

control_payment_receiver2stringOptionalExample: Yritys Oy

control_payment_code3stringOptionalExample: YVK

control_payment_date3stringOptionalExample: 2017-02-09

control_payment_amount3integerOptionalExample: 10

control_payment_ref3stringOptional

control_payment_receiver3stringOptionalExample: Yritys Oy

control_payment_code4stringOptionalExample: YVK

control_payment_date4stringOptionalExample: 2017-02-09

control_payment_amount4integerOptionalExample: 10

control_payment_ref4stringOptional

control_payment_receiver4stringOptionalExample: Yritys Oy

control_payment_code5stringOptionalExample: YVK

control_payment_date5stringOptionalExample: 2017-02-09

control_payment_amount5integerOptionalExample: 10

control_payment_ref5stringOptional

control_payment_receiver5stringOptionalExample: Yritys Oy

control_payment_code6stringOptionalExample: YVK

control_payment_date6stringOptionalExample: 2017-02-09

control_payment_amount6integerOptionalExample: 10

control_payment_ref6stringOptional

control_payment_receiver6stringOptionalExample: Yritys Oy

control_payment_code7stringOptionalExample: YVK

control_payment_date7stringOptionalExample: 2017-02-09

control_payment_amount7integerOptionalExample: 10

control_payment_ref7stringOptional

control_payment_receiver7stringOptionalExample: Yritys Oy

control_payment_code8stringOptionalExample: YVK

control_payment_date8stringOptionalExample: 2017-02-09

control_payment_amount8integerOptionalExample: 10

control_payment_ref8stringOptional

control_payment_receiver8stringOptionalExample: Yritys Oy

control_payment_code9stringOptionalExample: YVK

control_payment_date9stringOptionalExample: 2017-02-09

control_payment_amount9integerOptionalExample: 10

control_payment_ref9stringOptional

control_payment_receiver9stringOptionalExample: Yritys Oy

400

Bad request

application/json

404

Not found

application/json

get

/control/reports/{reportid}

HTTPcURLJavaScriptPython

GET /rest/control/reports/{reportid} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "reportId": "123",
  "controlId": "2000000",
  "timestamp": "2017-02-09T13:07:00+02:00",
  "control_govid": "1234567-8",
  "control_name": "Yritys Oy",
  "control_rating": "A",
  "control_paydex": "70",
  "control_ratingdate": "2017-02-09",
  "control_scoringchange": "",
  "control_ratingchange": "RAT",
  "control_namechange": "NIM",
  "control_newpaymentfault": "MHA",
  "control_newaccountingdetails": "TIL",
  "control_companydel": "LAK",
  "control_fusion": "FUU",
  "control_epr": "EPR",
  "control_prevrating": "C",
  "control_duns": "123456789",
  "control_receivinggovid": "1234567-8",
  "control_score": "80",
  "control_payment_code1": "YVK",
  "control_payment_date1": "2017-02-09",
  "control_payment_amount1": "10",
  "control_payment_ref1": "",
  "control_payment_receiver1": "Yritys Oy",
  "control_payment_code2": "YVK",
  "control_payment_date2": "2017-02-09",
  "control_payment_amount2": "10",
  "control_payment_ref2": "",
  "control_payment_receiver2": "Yritys Oy",
  "control_payment_code3": "YVK",
  "control_payment_date3": "2017-02-09",
  "control_payment_amount3": "10",
  "control_payment_ref3": "",
  "control_payment_receiver3": "Yritys Oy",
  "control_payment_code4": "YVK",
  "control_payment_date4": "2017-02-09",
  "control_payment_amount4": "10",
  "control_payment_ref4": "",
  "control_payment_receiver4": "Yritys Oy",
  "control_payment_code5": "YVK",
  "control_payment_date5": "2017-02-09",
  "control_payment_amount5": "10",
  "control_payment_ref5": "",
  "control_payment_receiver5": "Yritys Oy",
  "control_payment_code6": "YVK",
  "control_payment_date6": "2017-02-09",
  "control_payment_amount6": "10",
  "control_payment_ref6": "",
  "control_payment_receiver6": "Yritys Oy",
  "control_payment_code7": "YVK",
  "control_payment_date7": "2017-02-09",
  "control_payment_amount7": "10",
  "control_payment_ref7": "",
  "control_payment_receiver7": "Yritys Oy",
  "control_payment_code8": "YVK",
  "control_payment_date8": "2017-02-09",
  "control_payment_amount8": "10",
  "control_payment_ref8": "",
  "control_payment_receiver8": "Yritys Oy",
  "control_payment_code9": "YVK",
  "control_payment_date9": "2017-02-09",
  "control_payment_amount9": "10",
  "control_payment_ref9": "",
  "control_payment_receiver9": "Yritys Oy"
}

Get report in PDF-format

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

reportidintegerRequired

Id of report

Responses

200

Control report PDF encoded in base64

application/json

ControlPdfDataResponse

datastring · byteOptionalExample: base64encodeddata

400

Bad request

application/json

404

Not found

application/json

get

/control/reportspdf/{reportid}

HTTPcURLJavaScriptPython

GET /rest/control/reportspdf/{reportid} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": "base64encodeddata"
}