/api/lite/settings/counteragents

Получение перечня контрагентов

/api/lite/settings/counteragents

Возвращает перечень контрагентов по роли или по id

Параметры запроса: id - для загрузки одного контрагента. иначе загружаются все контрагенты аккаунта

extId - для загрузки одного контрагента с заданным внешним ID.

query - строка для поиска по наименованию, ИНН, ОГРН по включению

Паджинация стандартная: page, size (10 элементов по умолчанию)

примеры:

/api/lite/settings/counteragents?id=1647656c-080a-d01b-e2c4-362961f07e18

Виды контрагентов для поля role: CUSTOMER, FULFILLMENT_SERVICE, DELIVERY_SERVICE, CALLCENTER_SERVICE, PRODUCT_SUPPLIER

Пример успешного ответа:

{     
    "success": true,
    "recordsTotal": 3,
    "counteragents": [
         {
            "id": "c82e2616-91e7-702e-d666-320534119a13",
            "extId": "externalSystemID-123",
            "type": "COMPANY",
            "role": "PRODUCT_SUPPLIER",
            "name": " ИП Петров А.В.",
            "organization": {
                "id": "f23b14bf-1151-dcb5-1b25-57a2b931e3ac",
                "name": "ИП Петров А.В.",
                "fullName": "ИП Петров А.В.",
                "phones": null,
                "inn": "5018081484",
                "kpp": null,
                "ogrn": null,
                "okpo": null,
                "persons": null,
                "orgLegalType": "SELF_EMPLOYED",
                "address": {
                    "country": "Россия",
                    "countryCode": "RU",
                    "region": "Москва",
                    "area": null,
                    "city": "Москва",
                    "settlement": null,
                    "street": "Новоалексеевская",
                    "house": "18",
                    "block": "3",
                    "building": "",
                    "flat": null,
                    "fullAddress": "г Москва, Алексеевский р-н, ул Новоалексеевская, д 18 к 3",
                    "fullCity": null,
                    "rawData": null,
                    "zip": "129626",
                    "regionFias": null,
                    "areaFias": null,
                    "cityFias": null,
                    "settlementFias": null
                },
                "email": null
            },
            "person": null
        },
          {
            "id": "e627aba4-bfe7-0ecf-14d8-b120233d9446",
            "type": "PERSON",
            "role": null,
            "name": "Вано",
            "organization": null,
            "person": {
                "name": "Вано",
                "surname": "",
                "patronymic": "",
                "fullName": "Вано о",
                "phone": "323232323232323434",
                "rawPhone": null,
                "alternativePhone": "",
                "email": null,
                "post": null,
                "personType": null,
                "address": {
                    "country": "Россия",
                    "countryCode": "RU",
                    "region": "Алтайский",
                    "area": null,
                    "city": "Барнаул",
                    "settlement": null,
                    "street": "Барнаульская",
                    "house": "1",
                    "block": "",
                    "building": "",
                    "flat": "",
                    "fullAddress": "Алтайский, Барнаул, Барнаульская, д 1",
                    "fullCity": null,
                    "rawData": "Алтайский, Барнаул, Барнаульская, д 1",
                    "zip": "",
                    "regionFias": null,
                    "areaFias": null,
                    "cityFias": null,
                    "settlementFias": null
                }
            }
        }
    ]
}

 

/api/lite/settings/counteragents?extId=123-1234abc

Виды контрагентов для поля role: CUSTOMER, FULFILLMENT_SERVICE, DELIVERY_SERVICE, CALLCENTER_SERVICE, PRODUCT_SUPPLIER

Пример успешного ответа:

{     
    "success": true,
    "recordsTotal": 3,
    "counteragents": [
         {
            "id": "c82e2616-91e7-702e-d666-320534119a13",
            "extId": "123-1234abc",
            "type": "COMPANY",
            "role": "PRODUCT_SUPPLIER",
            "name": " ИП Петров А.В.",
            "organization": {
                "id": "f23b14bf-1151-dcb5-1b25-57a2b931e3ac",
                "name": "ИП Петров А.В.",
                "fullName": "ИП Петров А.В.",
                "phones": null,
                "inn": "5018081484",
                "kpp": null,
                "ogrn": null,
                "okpo": null,
                "persons": null,
                "orgLegalType": "SELF_EMPLOYED",
                "address": {
                    "country": "Россия",
                    "countryCode": "RU",
                    "region": "Москва",
                    "area": null,
                    "city": "Москва",
                    "settlement": null,
                    "street": "Новоалексеевская",
                    "house": "18",
                    "block": "3",
                    "building": "",
                    "flat": null,
                    "fullAddress": "г Москва, Алексеевский р-н, ул Новоалексеевская, д 18 к 3",
                    "fullCity": null,
                    "rawData": null,
                    "zip": "129626",
                    "regionFias": null,
                    "areaFias": null,
                    "cityFias": null,
                    "settlementFias": null
                },
                "email": null
            },
            "person": null
        },
          {
            "id": "e627aba4-bfe7-0ecf-14d8-b120233d9446",
            "type": "PERSON",
            "role": null,
            "name": "Вано",
            "organization": null,
            "person": {
                "name": "Вано",
                "surname": "",
                "patronymic": "",
                "fullName": "Вано о",
                "phone": "323232323232323434",
                "rawPhone": null,
                "alternativePhone": "",
                "email": null,
                "post": null,
                "personType": null,
                "address": {
                    "country": "Россия",
                    "countryCode": "RU",
                    "region": "Алтайский",
                    "area": null,
                    "city": "Барнаул",
                    "settlement": null,
                    "street": "Барнаульская",
                    "house": "1",
                    "block": "",
                    "building": "",
                    "flat": "",
                    "fullAddress": "Алтайский, Барнаул, Барнаульская, д 1",
                    "fullCity": null,
                    "rawData": "Алтайский, Барнаул, Барнаульская, д 1",
                    "zip": "",
                    "regionFias": null,
                    "areaFias": null,
                    "cityFias": null,
                    "settlementFias": null
                }
            }
        }
    ]
}

 

Создание/обновление контрагента

/api/lite/settings/counteragents

Создает или обновляет данные контрагента.

Поле id в контрагенте и в организации служит для поиска существующего контрагента/организации.

Поле type может иметь следующие значения:

• COMPANY
• PERSON

Поле orgLegalType может иметь следующие значения:

• SELF_EMPLOYED
• COMPANY
• OOO
• AO
• ZAO
• PAO

Пример запроса:

{   
            "id": "c82e2616-91e7-702e-d666-320534119a13",
            "extId": "externalSystemID-123",
            "type": "COMPANY",         
            "name": " ИП Петров А.В.",
            "organization": {
                "id": "f23b14bf-1151-dcb5-1b25-57a2b931e3ac",
                "name": "ИП Петров А.В.",
                "fullName": "ИП Петров А.В.",
                "phones": null,
                "inn": "5018081484",
                "kpp": null,
                "ogrn": null,
                "okpo": null,
                "persons": null,
                "orgLegalType": "SELF_EMPLOYED",
                "address": {
                    "country": "Россия",
                    "countryCode": "RU",
                    "region": "Москва",
                    "area": null,
                    "city": "Москва",
                    "settlement": null,
                    "street": "Новоалексеевская",
                    "house": "18",
                    "block": "3",
                    "building": "",
                    "flat": null,
                    "fullAddress": "г Москва, Алексеевский р-н, ул Новоалексеевская, д 18 к 3",
                    "fullCity": null,
                    "rawData": null,
                    "zip": "129626",
                    "regionFias": null,
                    "areaFias": null,
                    "cityFias": null,
                    "settlementFias": null
                },
                "postalAddress": {
                    "country": "Россия",
                    "countryCode": "RU",
                    "region": "Москва",
                    "area": null,
                    "city": "Москва",
                    "settlement": null,
                    "street": "Новоалексеевская",
                    "house": "18",
                    "block": "3",
                    "building": "",
                    "flat": null,
                    "fullAddress": "г Москва, Алексеевский р-н, ул Новоалексеевская, д 18 к 3",
                    "fullCity": null,
                    "rawData": null,
                    "zip": "129626",
                    "regionFias": null,
                    "areaFias": null,
                    "cityFias": null,
                    "settlementFias": null
                }
                "email": "abc@abc.ru"
            },
            "person": null
        }

Пример для физлица:

{
            "id": "e627aba4-bfe7-0ecf-14d8-b120233d9446",
  			"extId": "externalSystemID-123",
            "type": "PERSON",
            "role": null,
            "name": "Вано",
            "organization": null,
            "person": {
                "name": "Вано",
                "surname": "",
                "patronymic": "",
                "fullName": "Вано о",
                "phone": "323232323232323434",
                "rawPhone": null,
                "alternativePhone": "",
                "email": null,
                "post": null,
                "personType": null,
                "address": {
                    "country": "Россия",
                    "countryCode": "RU",
                    "region": "Алтайский",
                    "area": null,
                    "city": "Барнаул",
                    "settlement": null,
                    "street": "Барнаульская",
                    "house": "1",
                    "block": "",
                    "building": "",
                    "flat": "",
                    "fullAddress": "Алтайский, Барнаул, Барнаульская, д 1",
                    "fullCity": null,
                    "rawData": "Алтайский, Барнаул, Барнаульская, д 1",
                    "zip": "",
                    "regionFias": null,
                    "areaFias": null,
                    "cityFias": null,
                    "settlementFias": null
                }
            }
        }

Пример успешного ответа:

{     
    "success": true,
    "id": "c82e2616-91e7-702e-d666-320534119a13"
}

 

Удаление контрагента

/api/lite/settings/counteragents?id=2fe48a36-b1fd-b6f3-417b-689ff672c50d

Удаляет контрагента по его id. Если контрагент уже где-то используется, то при удалении возникнет ошибка.

 

Результат запроса:

{
        "success": true  
}

 

Ошибка:

{
  "success": false,
  "errors": [
    {
      "code": 0,
      "message": "текст ошибки"
    }
  ]
}