GetOrganizationsByInnKpp

Имя ресурса: /GetOrganizationsByInnKpp

HTTP метод: GET

Параметры строки запроса:

  • inn: ИНН организации;
  • kpp: КПП организации (может отсутствовать);
  • includeRelations: признак, указывающий на то, нужно ли возвращать данные о количестве контрагентов, заинтересованных в сотрудничестве с данной организацией;
  • outputFormat: формат вывода данных, может отсутствовать. Возможные значения: xml, protobuf (по-умолчанию - protobuf).

В запросе должен присутствовать HTTP-заголовок Authorization с необходимыми данными для авторизации.

В теле ответа содержатся справочные данные для организаций с заданными ИНН и КПП, сериализованные в запрошенном формате:

  • если в строке запроса не было параметра outputFormat, либо его значение было равно protobuf, данные возвращаются сериализованными в протобуфер OrganizationList;

  • если значение параметра outputFormat в строке запроса было равно xml, данные возвращаются в формате xml, как в следующем примере:

    <Organizations>
      <Organization id="orgId1" inn="1234567890" kpp="123456789" fullName="ООО Яблоко" shortName="ООО Яблоко" joinedDiadocTreaty="true">
        <Boxes>
          <Box id="boxId1" title="Ящик для счетов фактур" />
        </Boxes>
      </Organization>
      <Organization id="orgId2" inn="123456789012" kpp="" fullName="ИП Сидоров Иван Петрович" shortName="" joinedDiadocTreaty="false">
        <Boxes>
          <Box id="boxId3" title="Основной ящик" />
        </Boxes>
      </Organization>
    </Organizations>
    

Если параметр kpp отсутствует в строке запроса, то будет выдан список ящиков всех организаций, имеющих заданный ИНН.

Возможные HTTP-коды возврата:

  • 200 (OK) - операция успешно завершена;
  • 400 (Bad Request) - данные в запросе имеют неверный формат или отсутствуют обязательные параметры;
  • 401 (Unauthorized) - в запросе отсутствует HTTP-заголовок Authorization, или в этом заголовке содержатся некорректные авторизационные данные;
  • 405 (Method not allowed) - используется неподходящий HTTP-метод;
  • 500 (Internal server error) - при обработке запроса возникла непредвиденная ошибка.