Versions Compared

Old Version 5

changes.mady.by.user Оксана Нечепоренко

Saved on

compared with

New Version 6

changes.mady.by.user Оксана Нечепоренко

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Http Method

POST

Request URL

https://secure.ubki.ua/b2_api_xml/ubki/xml

Request JSON

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

"okpo": "EGPROU of the legal entity"

},

"additionaldata": {

"date": "Scoring date. Not filled in if the scoring is currently calculated"

},

"reqlng": "Search criteria language (code from ref.23)"

},

"version": "1.0",

"reqtype": "Template code (code from ref.49): 'Financial Report' - 42",

"reqreason": "Request objective (code from ref.24)"

},

"descr": "Request object"

},

"descr": "Request envelope"

},

"sessid": "Session key (obtained from the authorization API)"

}

}

}

Request XML
<request version="1.0" reqtype="Template

Response JSON

Expand
titlebody:

{

<?xml version="1.0" encoding="utf-8"?>

<doc>

<ubki sessid="Session key (obtained from the authorization API)">

<req_envelope descr="Request envelope">

<req_xml descr="Request object">

<!-- Request parameters -->

"ubkidata": {

"tech": {

"trace": {

"step": {

"name": "Step name",

"stm": "Step start stamp date",

"ftm": "Step finish stamp date"

}

},

"error": {

"errtype": "Error code (code from ref.

49): 'Financial Report' - 42" reqreason="Request objective (code

0)",

"errtext": "Error text (value from ref.

24

0)"

>

<!-- Parameters describing search criteria-->

<i reqlng="Search criteria language (code from ref.23)">

<!-- Subject identification parameters-->

<ident okpo="EGPROU of the legal entity" />

<additionaldata date="Scoring date. Not filled in if the scoring is currently calculated" />

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

Expand
titlebody:

<?xml version="1.0" encoding="utf-8"?>

<ubkidata>

<!-- System information part -->

<tech>

<trace>

<step name="Step name" stm="Step start stamp date" ftm="Step finish stamp date">

<!-- The trace part contains timing metrics of components generation steps -->

</step>

</trace>

<error errtype="Error code (code from ref.0)" errtext="Error text (value from ref.0)">

</error>

<reqinfo reqid="Outgoing request ID generated by UBKI">

</reqinfo>

<!-- Information about the current status of the prepaid account part-->

<billing>

<balance value="Total assets" date="Date" time="Time" />

</billing>

</tech>

<!-- FinancialReport-->

<comp id="62" descr="FinancialReport">

<financialReport okpo="EGPROU of the legal entity"

date="Scoring date. Not filled in if the scoring is currently calculated">

<finrepData rhId="Financial Report Id"

rhStaff="Number of employees in a legal entity for a specific period"

rhYear="Year of a financial report"

rhQuarter="Quarter number of a financial report"

rhEndDate="The еnd date of the relevant period"

formKind="Type of a legal entity"

rvCode="Code number of a financial report"

rvValue="Money in thousands UAH"

rvFormNo="Form number" />

<!--This block has to consist of the 1..* elements-->

</financialReport>

</comp>

</ubkidata>

Example

Request JSON

Code Block{ "doc": { "ubki": { "req_envelope": { "req_xml": { "request": { "i": { "ident": { "okpo": "12345632" }, "additionaldata": { "date": "" }, "reqlng": "4" }, "version": "1.0", "reqtype": "42", "reqreason": "2" } } }, "sessid": "EDF4309796114D6D9B8365370DA2DEE9

},

"reqinfo": {

"reqid": "Outgoing request ID generated by UBKI"

},

"billing": {

"balance": {

"value": "Total assets",

"date": "Date",

"time": "Time"

}

}

},

"comp": {

"financialReport": {

"finrepData": {

"rhId": "Financial Report Id",

"rhStaff": "Number of employees in a legal entity for a specific period",

"rhYear": "Year of a financial report",

"rhQuarter": "Quarter number of a financial report",

"rhEndDate": "The еnd date of the relevant period",

"formKind": "Type of a legal entity",

"rvCode": "Code number of a financial report",

"rvValue": "Money in thousands UAH",

"rvFormNo": "Form number"

},

"okpo": "EGPROU of the legal entity",

"date": "Scoring date. Not filled in if the scoring is currently calculated"

},

"id": "62",

"descr": "FinancialReport"

}

}

}

Request XML

Expand
title body:

<?xml version="1.0" encoding="utf-8"?>

<doc>

<ubki sessid="Session key (obtained from the authorization API)">

<req_envelope descr="Request envelope">

<req_xml descr="Request object">

<!-- Request parameters -->

<request version="1.0" reqtype="Template code (code from ref.49): 'Financial Report' - 42" reqreason="Request objective (code from ref.24)">

<!-- Parameters describing search criteria-->

<i reqlng="Search criteria language (code from ref.23)">

<!-- Subject identification parameters-->

<ident okpo="EGPROU of the legal entity" />

<additionaldata date="Scoring date. Not filled in if the scoring is currently calculated" />

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

Expand
titlebody:

<?xml version="1.0" encoding="utf-8"?>

<ubkidata>

<!-- System information part -->

<tech>

<trace>

<step name="Step name" stm="Step start stamp date" ftm="Step finish stamp date">

<!-- The trace part contains timing metrics of components generation steps -->

</step>

</trace>

<error errtype="Error code (code from ref.0)" errtext="Error text (value from ref.0)">

</error>

<reqinfo reqid="Outgoing request ID generated by UBKI">

</reqinfo>

<!-- Information about the current status of the prepaid account part-->

<billing>

<balance value="Total assets" date="Date" time="Time" />

</billing>

</tech>

<!-- FinancialReport-->

<comp id="62" descr="FinancialReport">

<financialReport okpo="EGPROU of the legal entity"

date="Scoring date. Not filled in if the scoring is currently calculated">

<finrepData rhId="Financial Report Id"

rhStaff="Number of employees in a legal entity for a specific period"

rhYear="Year of a financial report"

rhQuarter="Quarter number of a financial report"

rhEndDate="The еnd date of the relevant period"

formKind="Type of a legal entity"

rvCode="Code number of a financial report"

rvValue="Money in thousands UAH"

rvFormNo="Form number" />

<!--This block has to consist of the 1..* elements-->

</financialReport>

</comp>

</ubkidata>

Example

Request JSON

Code Block
{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"ident": {
								"okpo": "12345632"
							},
							"additionaldata": {
								"date": ""
							},
							"reqlng": "4"
						},
						"version": "1.0",
						"reqtype": "42",
						"reqreason": "2"
					}
				}
			},
			"sessid": "EDF4309796114D6D9B8365370DA2DEE9"
		}
	}
}

Response JSON

Code Block
{
	"ubkidata": {
		"tech": {
			"trace": {
				"step": {
					"name": "build report",
					"stm": "2022-08-29 14:05:54.436",
					"ftm": "2022-08-29 14:05:56.062"
				}
			},
			"reqinfo": {
				"reqid": "req2#000002461674"
			}
		},
		"comp": {
			"financialReport": {
				"finrepData": [
					{
						"rhId": "1234563220204",
						"rhStaff": "2",
						"rhYear": "2020",
						"rhQuarter": "4",
						"rhEndDate": "2020-12-31",
						"formKind": "S",
						"rvCode": "1100",
						"rvValue": "21.0000",
						"rvFormNo": "1"
					},
					{
						"rhId": "1234563220204",
						"rhStaff": "2",
						"rhYear": "2020",
						"rhQuarter": "4",
						"rhEndDate": "2020-12-31",
						"formKind": "S",
						"rvCode": "1103",
						"rvValue": "21.0000",
						"rvFormNo": "1"
					},
					{
						"rhId": "1234563220204",
						"rhStaff": "2",
						"rhYear": "2020",
						"rhQuarter": "4",
						"rhEndDate": "2020-12-31",
						"formKind": "S",
						"rvCode": "1165",
						"rvValue": "11.0000",
						"rvFormNo": "1"
					},
					{
						"rhId": "1234563220204",
						"rhStaff": "2",
						"rhYear": "2020",
						"rhQuarter": "4",
						"rhEndDate": "2020-12-31",
						"formKind": "S",
						"rvCode": "1195",
						"rvValue": "31.0000",
						"rvFormNo": "1"
					},
					{
						"rhId": "1234563220204",
						"rhStaff": "2",
						"rhYear": "2020",
						"rhQuarter": "4",
						"rhEndDate": "2020-12-31",
						"formKind": "S",
						"rvCode": "1300",
						"rvValue": "31.0000",
						"rvFormNo": "1"
					},
					{
						"rhId": "1234563220204",
						"rhStaff": "2",
						"rhYear": "2020",
						"rhQuarter": "4",
						"rhEndDate": "2020-12-31",
						"formKind": "S",
						"rvCode": "1420",
						"rvValue": "29.0000",
						"rvFormNo": "1"
					},
					{
						"rhId": "1234563220204",
						"rhStaff": "2",
						"rhYear": "2020",
						"rhQuarter": "4",
						"rhEndDate": "2020-12-31",
						"formKind": "S",
						"rvCode": "1495",
						"rvValue": "29.0000",
						"rvFormNo": "1"
					},
					{
						"rhId": "1234563220204",
						"rhStaff": "2",
						"rhYear": "2020",
						"rhQuarter": "4",
						"rhEndDate": "2020-12-31",
						"formKind": "S",
						"rvCode": "1615",
						"rvValue": "2.0000",
						"rvFormNo": "1"
					},
					{
						"rhId": "1234563220204",
						"rhStaff": "2",
						"rhYear": "2020",
						"rhQuarter": "4",
						"rhEndDate": "2020-12-31",
						"formKind": "S",
						"rvCode": "1695",
						"rvValue": "2.0000",
						"rvFormNo": "1"
					},
					{
						"rhId": "1234563220204",
						"rhStaff": "2",
						"rhYear": "2020",
						"rhQuarter": "4",
						"rhEndDate": "2020-12-31",
						"formKind": "S",
						"rvCode": "1900",
						"rvValue": "31.0000",
						"rvFormNo": "1"
					},
					{
						"rhId": "1234563220204",
						"rhStaff": "2",
						"rhYear": "2020",
						"rhQuarter": "4",
						"rhEndDate": "2020-12-31",
						"formKind": "S",
						"rvCode": "2000",
						"rvValue": "40.0000",
						"rvFormNo": "2"
					},
					{
						"rhId": "1234563220204",
						"rhStaff": "2",
						"rhYear": "2020",
						"rhQuarter": "4",
						"rhEndDate": "2020-12-31",
						"formKind": "S",
						"rvCode": "2050",
						"rvValue": "33.0000",
						"rvFormNo": "2"
					},
					{
						"rhId": "1234563220204",
						"rhStaff": "2",
						"rhYear": "2020",
						"rhQuarter": "4",
						"rhEndDate": "2020-12-31",
						"formKind": "S",
						"rvCode": "2180",
						"rvValue": "4.0000",
						"rvFormNo": "2"
					},
					{
						"rhId": "1234563220204",
						"rhStaff": "2",
						"rhYear": "2020",
						"rhQuarter": "4",
						"rhEndDate": "2020-12-31",
						"formKind": "S",
						"rvCode": "2280",
						"rvValue": "40.0000",
						"rvFormNo": "2"
					},
					{
						"rhId": "1234563220204",
						"rhStaff": "2",
						"rhYear": "2020",
						"rhQuarter": "4",
						"rhEndDate": "2020-12-31",
						"formKind": "S",
						"rvCode": "2285",
						"rvValue": "37.0000",
						"rvFormNo": "2"
					},
					{
						"rhId": "1234563220204",
						"rhStaff": "2",
						"rhYear": "2020",
						"rhQuarter": "4",
						"rhEndDate": "2020-12-31",
						"formKind": "S",
						"rvCode": "2290",
						"rvValue": "2.0000",
						"rvFormNo": "2"
					},
					{
						"rhId": "1234563220204",
						"rhStaff": "2",
						"rhYear": "2020",
						"rhQuarter": "4",
						"rhEndDate": "2020-12-31",
						"formKind": "S",
						"rvCode": "2300",
						"rvValue": "0.0000",
						"rvFormNo": "2"
					},
					{
						"rhId": "1234563220204",
						"rhStaff": "2",
						"rhYear": "2020",
						"rhQuarter": "4",
						"rhEndDate": "2020-12-31",
						"formKind": "S",
						"rvCode": "2350",
						"rvValue": "2.0000",
						"rvFormNo": "2"
					}
				],
				"okpo": "12345632",
				"date": ""
			},
			"id": "62",
			"descr": "FinancialReport"
		}
	}
}

Request XML

Code Block
<doc>
  <ubki sessid="EDF4309796114D6D9B8365370DA2DEE9">
    <req_envelope>
      <req_xml>
        <request version="1.0" reqtype="42" reqreason="2">
          <i reqlng="4">
            <ident okpo="12345632" />
            <additionaldata date="" />
          </i>
        </request>
      </req_xml>
    </req_envelope>
  </ubki>
</doc>

...