Versions Compared

Old Version 3

changes.mady.by.user Zlata

Saved on

compared with

New Version 4

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": "ЄДРПОУ"

},

"additionaldata": {

"date": "Дата розрахунку звіту. Не заповнюється, якщо розраховується на поточний момент"

},

"reqlng": "Мова критеріїв пошуку (Код із дов.23)"

},

"version": "1.0",

"reqtype": "Код шаблону (Код із дов.49): 'Звіт FinancialReport' - 42",

"reqreason": "Мета надання запиту (Код із дов.24)"

},

"descr": "Об'єкт запиту"

},

"descr": "Конверт запиту"

},

"sessid": "Сесійний ключ (отримуємо з API авторизації)"

}

}

}

Request XML

Expand
title body:

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

<doc>

<ubki sessid="Сесійний ключ (отримуємо з API авторизації)">

<req_envelope descr="Конверт запиту">

<req_xml descr="Об'єкт запиту">

<!-- Параметри запиту-->

<request version="1.0" reqtype="Код шаблону (Код із дов.49): 'Звіт FinancialReport' - 42" reqreason="Мета надання запиту (Код із дов.24)">

<!-- Параметри, що описують критерії пошуку-->

<i reqlng="Мова критеріїв пошуку (Код із дов.23)">

<!-- Параметри ідентифікації суб'єкт-->

<ident okpo="ЄДРПОУ" />

<additionaldata date="Дата розрахунку звіту. Не заповнюється, якщо розраховується на поточний момент" />

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

Expand
titlebody:

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

<ubkidata>

<!-- Блок системної інформації -->

<tech>

<trace>

<step name="Найменування кроку" stm="Дата штамп старту кроку" ftm="Дата штамп фінішу кроку">

<!-- Блок trace містить метрики таймінгу кроків формування компонентів -->

</step>

</trace>

<error errtype="Код помилки (Код із дов.0)" errtext="Текст помилки (Значення із дов.0)">

</error>

<reqinfo reqid="Вихідний ІД запиту, згенерований УБКІ">

</reqinfo>

<!-- Блок інформації щодо поточного стану рахунку припейд-->

<billing>

<balance value="Сума балансу" date="Дата" time="Час" />

</billing>

</tech>

<!-- Блок FinancialReport -->

<comp id="62" descr="Назва компоненти">

<financialReport okpo="ЄДРПОУ"

date="Дата для розрахунку звіту. Не заповнюється, якщо розраховується на поточний момент">

<finrepData rhId="ID фінансової звітності за відповідний період"

rhStaff="Кількість співробітників юридичної особи за відповідний період"

rhYear="Рік фінансової звітності"

rhQuarter="Номер кварталу фінансової звітності"

rhEndDate="Дата закінчення відповідного періоду"

formKind="Тип юридичної особи"

rvCode="Номер статті фінансового звіту"

rvValue="Сумма у тисячах грн"

rvFormNo="Номер форми фінансової звітності" />

<!--Даний блок повинен складатись з 0,1 ... * елементів -->

</financialReport>

</comp>

</ubkidata>

Приклад

Request JSON

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

Request XML

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

Response XML

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
  <tech>
    <trace>
      <step name="build report" stm="2022-01-10 11:16:31.86" ftm="2022-01-10 11:16:31.904" />
    </trace>
    <reqinfo reqid="req2#000002012588" />
  </tech>
  <comp id="62" descr="FinancialReport">
    <financialReport okpo="12345632" date="">
      <finrepData rhId="1234563220204" rhStaff="2" rhYear="2020" rhQuarter="4" rhEndDate="2020-12-31" formKind="S" rvCode="1100" rvValue="21.0000" rvFormNo="1" />
      <finrepData rhId="1234563220204" rhStaff="2" rhYear="2020" rhQuarter="4" rhEndDate="2020-12-31" formKind="S" rvCode="1103" rvValue="21.0000" rvFormNo="1" />
      <finrepData rhId="1234563220204" rhStaff="2" rhYear="2020" rhQuarter="4" rhEndDate="2020-12-31" formKind="S" rvCode="1165" rvValue="11.0000" rvFormNo="1" />
      <finrepData rhId="1234563220204" rhStaff="2" rhYear="2020" rhQuarter="4" rhEndDate="2020-12-31" formKind="S" rvCode="1195" rvValue="31.0000" rvFormNo="1" />
      <finrepData rhId="1234563220204" rhStaff="2" rhYear="2020" rhQuarter="4" rhEndDate="2020-12-31" formKind="S" rvCode="1300" rvValue="31.0000" rvFormNo="1" />
      <finrepData rhId="1234563220204" rhStaff="2" rhYear="2020" rhQuarter="4" rhEndDate="2020-12-31" formKind="S" rvCode="1420" rvValue="29.0000" rvFormNo="1" />
      <finrepData rhId="1234563220204" rhStaff="2" rhYear="2020" rhQuarter="4" rhEndDate="2020-12-31" formKind="S" rvCode="1495" rvValue="29.0000" rvFormNo="1" />
      <finrepData rhId="1234563220204" rhStaff="2" rhYear="2020" rhQuarter="4" rhEndDate="2020-12-31" formKind="S" rvCode="1615" rvValue="2.0000" rvFormNo="1" />
      <finrepData rhId="1234563220204" rhStaff="2" rhYear="2020" rhQuarter="4" rhEndDate="2020-12-31" formKind="S" rvCode="1695" rvValue="2.0000" rvFormNo="1" />
      <finrepData rhId="1234563220204" rhStaff="2" rhYear="2020" rhQuarter="4" rhEndDate="2020-12-31" formKind="S" rvCode="1900" rvValue="31.0000" rvFormNo="1" />
      <finrepData rhId="1234563220204" rhStaff="2" rhYear="2020" rhQuarter="4" rhEndDate="2020-12-31" formKind="S" rvCode="2000" rvValue="40.0000" rvFormNo="2" />
      <finrepData rhId="1234563220204" rhStaff="2" rhYear="2020" rhQuarter="4" rhEndDate="2020-12-31" formKind="S" rvCode="2050" rvValue="33.0000" rvFormNo="2" />
      <finrepData rhId="1234563220204" rhStaff="2" rhYear="2020" rhQuarter="4" rhEndDate="2020-12-31" formKind="S" rvCode="2180" rvValue="4.0000" rvFormNo="2" />
      <finrepData rhId="1234563220204" rhStaff="2" rhYear="2020" rhQuarter="4" rhEndDate="2020-12-31" formKind="S" rvCode="2280" rvValue="40.0000" rvFormNo="2" />
      <finrepData rhId="1234563220204" rhStaff="2" rhYear="2020" rhQuarter="4" rhEndDate="2020-12-31" formKind="S" rvCode="2285" rvValue="37.0000" rvFormNo="2" />
      <finrepData rhId="1234563220204" rhStaff="2" rhYear="2020" rhQuarter="4" rhEndDate="2020-12-31" formKind="S" rvCode="2290" rvValue="2.0000" rvFormNo="2" />
      <finrepData rhId="1234563220204" rhStaff="2" rhYear="2020" rhQuarter="4" rhEndDate="2020-12-31" formKind="S" rvCode="2300" rvValue="0.0000" rvFormNo="2" />
      <finrepData rhId="1234563220204" rhStaff="2" rhYear="2020" rhQuarter="4" rhEndDate="2020-12-31" formKind="S" rvCode="2350" rvValue="2.0000" rvFormNo="2" />
    </financialReport>
  </comp>
</ubkidata>

...