Группа /counterparts/ — справочники для работы с контрагентами / данные контрагентов
Доступ
- Зарегистрированные пользователи
Комментарии
-
Метод выводит основные формы собственности контрагентов для передачи данных контрагентов в методах подачи заявок.
-
Формы собственности выбираются независимо от стран регистрации контрагентов. Корректное указание формы собственности контрагентов ускорит оформление Ваших грузов.
-
Формы собственности не имеют смысла для физических лиц.
Формат запроса
// Пустой объект или null
{
}
Формат ответа
[ // Общий перечень форм собственности [Array]
{ // Информация о форме собственности [Object]
"name": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ", // наименование [String]
"shortName": "ООО" // краткое наименование [String]
},
{
"name": "ТОВАРИЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ",
"shortName": "ТОО"
}
...
]
Метод /counterparts/confirmedaccesstocounterparties/ — список контрагентов, которые подтвердили свою связь с логином
Доступ
Комментарии
-
Метод выводит список контрагентов, которые подтвердили доступ к своим данным в компании ПЭК для логина, под которым выполняется запрос по API.
Формат запроса
{
"access_token": "eyJhbGciOiJIUzI........sW_FpoqHVDf1p2a4pf5WnPLHKEL-MGC87nA" // Токен для авторизации [String]. Получается методом /auth/createtokentoaccessprivatedata/
}
Формат ответа
[{ // пример элемента для физ.лица
"legalForm": 3, // Тип контрагента [Number]. Значения: 1 - Юридическое лицо, 2 - Индивидуальный предприниматель, 3 - Физическое лицо
"title": "ИВАНОВ ИВАН ИВАНОВИЧ" // Наименование контрагента / ФИО [String]
"guid": "3f55ea95-59ca-4f7a-868d-65fd5678391e"; // Уникальный идентификатор (GUID) контрагента в системах ПЭК [String]. Используется в ряде методов API
"documents": [// данные документа, удостоверяющего личность физ.лица
{
"documentType": {
"type": 10, //Тип документа в кодировке ПЭК [Number] (
// 0 - БЕЗ ПРЕДОСТАВЛЕНИЯ ДОКУМЕНТА (серию\номер можно оставить пустыми) - см. комментарии,
// 1 - ПАСПОРТ ИНОСТРАННОГО ГРАЖДАНИНА,
// 2 - РАЗРЕШЕННИЕ НА ВРЕМЕННОЕ ПРОЖИВАНИЕ, 3 - ВОДИТЕЛЬСКОЕ УДОСТОВЕРЕНИЕ,
// 4 - ВИД НА ЖИТЕЛЬСТВО, 5 - ЗАГРАНИЧНЫЙ ПАСПОРТ, 6 - УДОСТОВЕРЕНИЕ БЕЖЕНЦА,
// 7 - ВРЕМЕННОЕ УДОСТОВЕРЕНИЕ ЛИЧНОСТИ ГРАЖДАНИНА РФ,
// 8 - СВИДЕТЕЛЬСТВО О ПРЕДОСТАВЛЕНИИ ВРЕМЕННОГО УБЕЖИЩА НА ТЕРРИТОРИИ РФ,
// 9 - ПАСПОРТ МОРЯКА, 10 - ПАСПОРТ ГРАЖДАНИНА РФ,
// 11 - СВИДЕТЕЛЬСТВО О РАССМОТРЕНИИ ХОДАТАЙСТВА О ПРИЗНАНИИ БЕЖЕНЦЕМ,
// 12 - ВОЕННЫЙ БИЛЕТ)
"name": "Паспорт гражданина РФ", // Наименование типа документа удостоверяющего личность [String]
},
"series": "0704", // Серия документа удостоверяющего личность [String]
"number": "070423", // Номер документа удостоверяющего личность [String]
"expiredDate": "2023-06-29" //Дата окончания действия документа удостоверяющего личность [Date]
}
],
"legal": null
}, { // пример элемента для юр.лица / ИП
"legalForm": 1,
"title": "КЕМИЛАЙН ГРУПП"
"guid": "c380c264-8096-11e6-80c2-2c768a4f7e07";
"documents": null,
"legal": { // идентификаторы юридических лиц и индивидуальных предпринимателей
"inn": "7714850334", // ИНН [String]
"kpp": "771401001" // КПП [String]
}
}
]
Метод /counterparts/connecteddiscountsservicesagreements/ — список подключенных контрагенту скидок, сервисов и основных доп.соглашений
Доступ
Комментарии
-
Метод выводит информацию по подключенным в ПЭК сервисам, скидкам и основным дополнительным соглашениям по конкретному контрагенту. Для работы метода контрагент должен подтвердить, что связан с логином, который указан при авторизации (см. вопрос "Как подтвердить личный кабинет на сайте pecom.ru?" внизу страницы: https://pecom.ru/business/integration/#ltl-ltl)
-
Основные сервисы, доп. соглашения, которые могут повлиять на процесс интеграции с клиентами, и их важные параметры приведены в описании примера ответа метода с необходимыми пояснениями по правилам их использования.
-
Если какая-то запись есть в ответе - значит сервис по контрагенту подключен и действует на момент вызова запроса. Данные по срокам действия необходимо уточнять у своего менеджера ПЭК
-
Массив params, выводимый в массиве specialConditionsWithParams, в некоторых случаях содержит дополнительную информацию по особенностям применения скидок и сервисов. Пример основных параметров, которые там могут быть приведены, в описании формат ответа. В общем случае для пояснения логики работы тех или иных сервисов и скидок, прямо не представленных в примере ответа метода, необходимо обращаться к Вашему менеджеру ПЭК. API является "витриной" и специалисты по API не имеют достаточных компетенций в консультациях по особенностям всего объема скидок и сервисов.
Формат запроса
{
"access_token": "eyJhbGciOiJIUzI........sW_FpoqHVDf1p2a4pf5WnPLHKEL-MGC87nA", // Токен для авторизации [String]. Обязательный.
// См. метод /auth/createtokentoaccessprivatedata/)
"counterpartGUID": "48305ff1-8cd7-11e4-bce7-984be1640252" // Уникальный идентификатор (GUID) контрагента в системах ПЭК [String]. Обязательный.
// См. метод )
}
Формат ответа
{
"availableTypesOfDelivery": [3,12,1,5], // Массив доступных контрагенту идентификаторов продуктов/тарифов [Array of Number].
// Полный список доступных в API продуктов/тарифов можно получить методом /TYPESOFDELIVERY/ALL/
"additionalAgreements": [ // Массив с данными по основным подключенным дополнительным соглашениям (могут быть выведены только те, что представлены ниже).
// Все прочие в настоящее время не выводятся.
{
"specialCondition": {
"UID": "739293fd-edc7-495d-9e56-6f61ad39bb8c", // Соглашение о Наложеннном платеже UID [String]. Если есть в ответе - контрагенты могут подавать заявки с наложенным платежом
"Title": "Наложенный платеж" // Наименование доп.соглашения [String]
},
"beginDate": "2022-07-04T00:00:00", // Актуальная дата начала действия соглашения [DateTime]
"endDate": "2023-08-31T23:59:59" // Актуальная дата окончания действия соглашения [DateTime]
}, {
"specialCondition": {
"UID": "9ad369eb-1781-11e8-80c9-00155d668927", // Соглашение о работе с продуктом EasyWay UID [string]. Если есть в ответе - контрагент может подавать заявки по продукту EasyWay (он обязательно указывается как отправитель). Если в ответе метода нет этой записи, то все поданные заявки по продукту EasyWay будут автоматически отнесены к тарифу/продукту LTL Авто.
"Title": "Доставка для интернет-магазинов" // Наименование доп.соглашения [string]
},
"beginDate": "2022-07-04T00:00:00",
"endDate": "2023-08-31T23:59:59",
}, {
"specialCondition": {
"UID": "CIS_Get_CIS_principals_availableEDI", // В личном кабинете ПЭК контрагенту получен Продвинутый доступ [string]. В API позволяет получать расчеты цен с учетом скидок
"Title": "Соглашение о дистанционном обслуживании" // Наименование доп.соглашения [string]
},
"beginDate": "2000-01-01T00:00:00", // Для этой записи выводятся предопределенные занчения [DateTime]
"endDate": "2199-06-30T23:59:59", // Для этой записи выводятся предопределенные значения [DateTime]
}
],
"specialConditionsWithParams": [ // Перечень всех подключенных контрагенту сервисов и скидок с их основными параметрами
{
"specialCondition": {
"UID": "ffb40421-4761-11e8-80c9-00155d668927", // UID сервиса/типа скидки [String]
"Title": "Упрощенная выдача" // Название сервиса/ типа скидки [String]. Оформление грузов с выдачей получателю физ. лицу по СМС коду (без передачи в ПЭК данных документа, удостоверяющего личность получателя физ. лица).
// На получателей юр. лиц/ ИП не распространяется
},
"params": [{
"name": "Максимальная сумма НП",
"key": "CODMaxSum",
"type": "Money",
"values": 100000.00 //Максимальная объявленная стоимость конкретного груза (рубли), при которой сервис "Упрощенная выдача" доступен [Number]
}
// Прочие параметры не имеют значения для данного сервиса
]
}, {
"specialCondition": {
"UID": "394d1991-9f64-11e8-80ca-00155d444127",
"Title": "Упрощённый забор груза" // Подключена возможность подачи раздельных "Заявки на машину для забора грузов" (без указания конкретных грузов) и "Заявок на перевозку (при заборе)"
// При этом срок подачи "Заявок на перевозку" не регламентируется и будут забраны даже свежесозданные заявки, когда водитель уже на адресе забора
},
"params": []// Можно игнорировать, данный сервис работает в целом на контрагента без привязки к филиалу
}, {
"specialCondition": {
"specialCondition": {
"UID": "60fa77f8-e280-4b58-a885-816724e8aa51", // Скидка на километраж
"Title": "Километраж"
},
},
"params": [{
"name": "Установленное значение СУ", // Название параметра [String]. В данном примере основное значение подключенного сервиса/скидки
"key": "ValueSpecialCondition", // Идентификатор парамтера [String]
"type": "Numeric", // Тип значения [String]. Возможные значения Numeric, String, UNIQUEIDENTIFIER, Money
"values": "10" // Установленное значение сервиса/скидки [String]
}, {
"name": "Филиал установки СУ", // Суть параметра: филиал, в котором установлена скидка/сервис. В некоторых случаях/ для некоторых сервисов/скидок влияет на место применения
"key": "BranchUID",
"type": "UNIQUEIDENTIFIER",
"values": "B473CE9F-DD68-44EA-A4B2-4CB63B6E970D"
},
// Параметры выводятся в ответе метода, только если установлены для сервиса/скидки
{
"name": "Применять только когда контрагент - отправитель",
"key": "TheCounterpartSender",
"type": "Boolean",
"values": "true"
}, {
"name": "Применять только когда контрагент - плательщик",
"key": "TheCounterpartPayer",
"type": "Boolean",
"values": "true"
}, {
"name": "Применять только когда контрагент - получатель",
"key": "TheCounterpartRecipient",
"type": "Boolean",
"values": "true"
}, {
"name": "Применение только по филиалу получателя",
"key": "TheBranchRecipient",
"type": "Boolean",
"values": "true"
}, {
"name": "Применение только по филиалу отправителя",
"key": "TheBranchSender",
"type": "Boolean",
"values": "true"
}
]
}
}
]
}
