Counterparty search result (array of objects)

JSON:

[
  {
    "id": {
      "guid": {},
      "id": 41249,
      "gln": "9864119011415",
      "companyId": 9549,
      "retailerId": 7,
      "isUzdAts": 1,
      "isFinCrypt": 0,
      "countryId": 2,
      "isERNN": 3,
      "name": "ТОВ Варус",
      "companyType": "fiz",
      "companyInn": "1234567890",
      "companyKpp": "44444444",
      "zip": "03061",
      "city": "м. Київ",
      "street": "вул. Михайла Донця, 8",
      "otherInfo": "[]",
      "dpiCReg": 26,
      "dpiCRaj": 1,
      "account": {
        "id": 9549,
        "name": "Варус",
        "ownership": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ",
        "inn": "307423114208",
        "kpp": "30742316",
        "mail": "varus_mk@mail.ru",
        "identificators": [],
        "phone": "380512360238",
        "ndsNumber": "100152275",
        "users": [],
        "billingMail": "varus_mk@mail.ru",
        "bankName": "-",
        "bankAccount": "-",
        "bankMfo": "-",
        "bankAddress": "-",
        "agreemNumber": "Договір оферта",
        "agreemDate": "2020-10-06 16:09:10",
        "isOffert": true,
        "country": "UA",
        "address": "м. Миколаїв, вул. Чкалова 55",
        "legalAddress": "Миколаївська обл., Жовтневий р-н., с. Погорілове, вул. Ольшанського 11",
        "factAddress": "м. Миколаїв, вул. Чкалова 55",
        "directorName": "-",
        "tariffVersion": 1,
        "directorPosition": "-",
        "registrationDate": "2012-11-27 00:00:00",
        "allowUnsignedComdoc": 0,
        "allowUnsignedCondra": 0,
        "platform": "FELEX",
        "autoProlongation": true,
        "docBasisForNTM": 0,
        "isSignConfirm": 0,
        "sessionsTTL": 3600,
        "companies": []
      },
      "isDeclarDateNumRequired": true,
      "distribexUser": 1,
      "isWithoutTax": true,
      "taxSource": 1,
      "isSignConfirm": 0,
      "isSpecification": 1
    },
    "limits": {},
    "regions": [
      "Запорізька",
      "Волинська",
      "Сумська",
      "Харківська",
      "Полтавська",
      "Дніпропетровська",
      "Португалія"
    ],
    "categories": [
      {
        "groupd_id": 608,
        "parent_group_id": 607,
        "name": "Мʼясні консерви",
        "children": []
      },
      {
        "groupd_id": 609,
        "parent_group_id": 604,
        "name": "Тютюнові вироби",
        "children": []
      },
      {
        "groupd_id": 610,
        "parent_group_id": 609,
        "name": "Сигари, сигарили, тютюн",
        "children": []
      },
      {
        "groupd_id": 611,
        "parent_group_id": 605,
        "name": "Кава",
        "children": []
      },
      {
        "groupd_id": 604,
        "parent_group_id": 0,
        "name": "Продукти харчування, тютюнові вироби, напої",
        "children": []
      },
      {
        "groupd_id": 605,
        "parent_group_id": 604,
        "name": "Безалкогольні напої",
        "children": []
      },
      {
        "groupd_id": 606,
        "parent_group_id": 605,
        "name": "Чай",
        "children": []
      },
      {
        "groupd_id": 607,
        "parent_group_id": 604,
        "name": "Бакалія",
        "children": []
      }
    ]
  },
  {
    "id": {
      "guid": {},
      "manager": "#",
      "id": 13200791,
      "gln": "9864065732303",
      "companyId": 32657,
      "retailerId": 16267,
      "isUzdAts": 0,
      "isFinCrypt": 0,
      "countryId": 2,
      "isERNN": 0,
      "name": "Сухаренко Олег Андрійович (Тест)",
      "companyType": "fiz",
      "companyInn": "1010101016",
      "companyKpp": "34554363",
      "zip": "996633",
      "city": "г. Киев",
      "street": "ул. Трудится, 7",
      "phone": "380696969696",
      "otherInfo": "[]",
      "dpiCReg": 26,
      "dpiCRaj": 1,
      "account": {
        "id": 32657,
        "name": "Test_EDS3",
        "ownership": "#",
        "inn": "3030303030",
        "kpp": "300000003",
        "mail": "test@qw.we",
        "identificators": [],
        "phone": "134567890987",
        "ndsNumber": "#",
        "users": [],
        "billingMail": "test@qw.we",
        "bankName": "АТ «Банк»",
        "bankAccount": "66483000010000032009102701111",
        "bankMfo": "651006",
        "bankAddress": "г. Банковский, ул. Банковская, 666",
        "agreemNumber": "Договір оферта",
        "agreemDate": "2020-10-06 22:15:48",
        "isOffert": true,
        "country": "UA",
        "address": "#",
        "legalAddress": "#",
        "factAddress": "#",
        "directorName": "#",
        "tariffVersion": 2,
        "directorPosition": "#",
        "registrationDate": "2019-10-29 00:00:00",
        "allowUnsignedComdoc": 0,
        "allowUnsignedCondra": 1,
        "platform": "FELEX",
        "autoProlongation": true,
        "docBasisForNTM": 0,
        "isSignConfirm": 0,
        "sessionsTTL": 3600,
        "companies": []
      },
      "isDeclarDateNumRequired": true,
      "distribexUser": 1,
      "isWithoutTax": false,
      "taxSource": 0,
      "isSignConfirm": 1,
      "isSpecification": 0
    },
    "limits": {},
    "regions": [
      null,
      "Ivano-Frankivsk",
      "Волинська",
      "Сумська",
      "Cherkasy",
      "Грузія",
      "Харківська",
      "Полтавська",
      "Кіровоградська",
      "Закарпатська",
      "Португалія",
      "Запорізька",
      "Ватикан",
      "Lviv",
      "Данія",
      "Казахстан",
      "Львівська",
      "Italy",
      "Житомирська",
      "Чернігівська",
      "Дніпропетровська",
      "Kharkiv"
    ],
    "categories": [
      {
        "groupd_id": 132,
        "parent_group_id": 0,
        "name": "Tea",
        "children": []
      },
      {
        "groupd_id": 260,
        "parent_group_id": 114,
        "name": "Грінфілд",
        "children": []
      },
      {
        "groupd_id": 292,
        "parent_group_id": 132,
        "name": "Greenfield",
        "children": []
      },
      {
        "groupd_id": 262,
        "parent_group_id": 260,
        "name": "Листовий ж/б",
        "children": []
      },
      {
        "groupd_id": 294,
        "parent_group_id": 292,
        "name": "Sheet ж/б",
        "children": []
      },
      {
        "groupd_id": 264,
        "parent_group_id": 0,
        "name": "Кава",
        "children": []
      },
      {
        "groupd_id": 296,
        "parent_group_id": 127,
        "name": "Jockey",
        "children": []
      },
      {
        "groupd_id": 266,
        "parent_group_id": 264,
        "name": "Жокей",
        "children": []
      },
      {
        "groupd_id": 298,
        "parent_group_id": 296,
        "name": "cereal ",
        "children": []
      },
      {
        "groupd_id": 268,
        "parent_group_id": 266,
        "name": "Зернову",
        "children": []
      },
      {
        "groupd_id": 114,
        "parent_group_id": 0,
        "name": "Чай",
        "children": []
      },
      {
        "groupd_id": 306,
        "parent_group_id": 0,
        "name": "Пиво",
        "children": []
      },
      {
        "groupd_id": 276,
        "parent_group_id": 0,
        "name": "тест",
        "children": []
      },
      {
        "groupd_id": 308,
        "parent_group_id": 306,
        "name": "Грінфілд",
        "children": []
      },
      {
        "groupd_id": 310,
        "parent_group_id": 308,
        "name": "Листовий ж/б",
        "children": []
      },
      {
        "groupd_id": 312,
        "parent_group_id": 276,
        "name": "Жокей",
        "children": []
      },
      {
        "groupd_id": 314,
        "parent_group_id": 312,
        "name": "Зернову",
        "children": []
      },
      {
        "groupd_id": 127,
        "parent_group_id": 0,
        "name": "Coffee",
        "children": []
      }
    ]
  }
]

Table 1 - Parameters description of object

Parameter

Format

Description

Object

id

Identificator

object; information about the organization

limits

Limits

object; limitation

regions

List<EDistribexRegion>

array; region or country of availability of the goods

categories

List<XProductGroup>

array of objects; groups / categories of goods

categoriesNew

List<ProductCategory>

array of objects; groups / categories of goods

Table 2 - Parameters description of object Identificator

Parameter

Format

Description

Object Identificator

guid

String

organization GUID

taxNum

String (50)

Tax identification number

ndsNum

String(50)

№ VAT certificates

manager

String(100)

manager full name

accountant

String(100)

accountant name

id

long

GLN ID

gln

String (13)

organization GLN

companyId

long

account id; numeric

retailerId

long

network id (retailer); numeric

isUzdAts

int

ESD from АТС; 0-no, 1-yes

isFinCrypt

int

FINDOC encryption; 0-no, 1-yes

countryId

int

country identifier

isERNN

int

DECLAR processing scheme; 0 - sending to the recipient only after successful registration in the registry, 1 - registration after verification by the recipient, 3 - sending to the recipient without registration

name

String(100)

the name of the organization

nameEn

String

the name of the organization in Latin

companyType

String(5)

form of ownership; jur - Legal entity, fiz - Individual

companyInn

String(50)

company TIN code

companyKpp

String(50)

USREOU / PPC code

companyOgrn

String(15)

Primary State Registration Number

companyTaxDepartmentID

String

tax office department identifier

dirLastName

String(150)

director’s last name

dirFirstName

String(150)

director’s name

director

String(100)

full name of the director

apartment

String(20)

apartment

zip

String(20)

zip code

city

String(50)

city

street

String(100)

street name

regionCode

String(3)

region code

bankName

String(100)

bank name

bankMfo

String

MFI bank code, bank requisites

phone

String(50)

phone

bankAccount

String(50)

bank checking account

otherInfo

String

comments

email

String(255)

Email

metroCode

String(20)

delivery point code

IBAN

String

IBAN (International Bank Account Number)

district

String

district name

dpiCReg

String

region/area of the tax office

dpiCRaj

String

district (by region) binding to the tax office

account

Account_

account id

isDeclarDateNumRequired

boolean

Tax invoice in the Commodity invoice binding № and date (METRO)

distribexUser

int

service user; 1-Manufacturer; 2-Distributor

isWithoutTax

boolean

VAT non-payer

additionalInfo

IdentificatorAdditionalInfo_

Additional Information

taxSource

int

Identification code of the tax number source

  • 0 - absent

  • 1 - Unified State Register of Enterprises and Organizations of Ukraine (USREOU);

  • 2 - State register of natural persons – taxpayers (SRNP);

  • 3 - registration (account) number (for taxpayers who are not included in the USREOU);

  • 4 - passport series and number (for individuals who, due to religious beliefs, refuse to accept a registration number)

isSignConfirm

int

gln confirmed by QES (0-no; 1-yes)

isSpecification

int

access to the E-Specification service (0-no; 1-yes)

Table 3 - Parameters description of object Limits

Parameter

Format

Description

Object Limits

credit_limit

float (10.4)

credit limit, UAH

max_pack_qty

positive number (10)

maximum number of boxes

max_pallet_qty

positive number (10)

maximum number of pallets

max_pos_qty

positive number (10)

maximum number of items in the order

max_sum_nds

float (10,4)

maximum amount of the order with VAT, UAH.

max_sum_without_nds

float (10,4)

maximum order amount without VAT, UAH.

max_weight

float (13,3)

maximum order weight, kg

min_sum_nds

float (10.4)

minimum order amount including VAT, UAH.

min_sum_without_nds

float (10,4)

minimum order amount without VAT, UAH.

multiplicity_packing

int

multiplicity of packing; 0-no, 1-yes

surcharge_rate

float (10.2)

Surcharge rate, UAH.

multiplicity_min_order_qty

int

Multiplicity of minimum order quantity; 0-no, 1-yes

Table 4 - Parameters description of object XProductGroup

Parameter

Format

Description

Object XProductGroup

groupd_id

long

identifier

  • for Distribution service: line / category / subcategory

  • for Have Product service: category / group / subgroup

parent_group_id

long

identifier of the highest level in the structure:

  • for Distribution service: line / category

  • for Have Product service: category / group

name

String

name

  • for Distribution service: line / category / subcategory

  • for Have Product service: category / group / subgroup

children

List <groupd_id>

array; list of all child IDs:

  • for Distribution service: category / subcategory identifier

  • for Have Product service: group / subgroup identifier

Table 5 - Parameters description of object ProductCategory

Parameter

Format

Description

Object ProductCategory

id

long

category / group / subgroup identifier

parentId

long

parent category / group ID

name

String

category / group / subgroup name

nameEng

String

the English name of the category / group / subgroup

status

int

status

Table 6 - Parameters description of object EDistribexRegion

Parameter

Format

Description

Object EDistribexRegion

id

int

record identifier

countryId

int

country identifier

countryRegionId

int

region identifier

name

String

the name of the region or country

nameEn

String

the name of the region or country in English