GET api/v2/documentGroups?DeletedFilter={DeletedFilter}&Direction={Direction}&StartIndex={StartIndex}&Count={Count}&Contractor={Contractor}&ContractorId={ContractorId}&Department={Department}&DepartmentId={DepartmentId}&EndSentDate={EndSentDate}&StartSentDate={StartSentDate}&Title={Title}&Search={Search}&State={State}&ContractorInn={ContractorInn}&StartReceiveDate={StartReceiveDate}&EndReceiveDate={EndReceiveDate}

Список групп документов

Информация о запросе

GET параметры

НазваниеОписаниеТипДополнительная информация
DeletedFilter

Фильтр по удаленным

DeletedFilter

Нет.

Direction

Тип списка документов

DocumentDirection

Нет.

StartIndex

Начальный индекс

integer

Нет.

Count

Количество записей (не более 50)

integer

Нет.

Contractor

ИНН(полное совпадение) или название (частичный поиск) (не менее 3х символов иначе поиск не производится)

string

Нет.

ContractorId

Идентификатор контрагента

globally unique identifier

Нет.

Department

КПП(полное совпадение) или название (частичный поиск) (не менее 3х символов иначе поиск не производится)

string

Нет.

DepartmentId

Идентификатор подразделения

globally unique identifier

Нет.

EndSentDate

Начальная дата отправки

date

Нет.

StartSentDate

Конечная дата отправки

date

Нет.

Title

Название документа

string

Нет.

Search

Общий поиск (название документа, контрагент, подразделение)

string

Нет.

State

Статус документа

DocumentState

Нет.

ContractorInn

ИНН контрагента

string

Нет.

StartReceiveDate

Дата начала получения

date

Нет.

EndReceiveDate

Дата конца получения

date

Нет.

Body параметры

Нет.

Информация об ответе

Информация о ресурсах

Список групп документов

DocumentGroupList
НазваниеОписаниеТипДополнительная информация
NextPageUrl

Ссылка на следующую страницу (если пустая ссылка, то больше нет страниц)

string

Нет.

Items

Группы документов

Массив DocumentGroup

Нет.

Форматы ответа

application/json, text/json

Пример:
{
  "NextPageUrl": "sample string 1",
  "Items": [
    {
      "Id": "752ae079-ce0b-44ae-a11b-a78f9512c752",
      "Contractor": {
        "Id": "8006ccb7-5215-4e4d-b80a-d69d59a56f20",
        "Name": "sample string 2",
        "Inn": "sample string 3",
        "Kpp": "sample string 4",
        "IsRoaming": true
      },
      "SentDate": "2019-08-25T01:08:31.7451991+03:00",
      "State": 0,
      "Documents": [
        {
          "Id": "3e00e546-3f2c-4faa-ad92-c5a38253fb8e",
          "Title": "sample string 2",
          "ReceivedDate": "2019-08-25T01:08:31.7451991+03:00",
          "State": 0,
          "Type": {
            "Code": 1,
            "Name": "sample string 2"
          },
          "Department": {
            "Id": "551037ab-3db7-476d-96e1-40158db4343c",
            "Name": "sample string 2"
          },
          "IsReaded": true,
          "SentDate": "2019-08-25T01:08:31.7461914+03:00",
          "NeedResign": true,
          "Direction": 0,
          "IsDeleted": true
        },
        {
          "Id": "3e00e546-3f2c-4faa-ad92-c5a38253fb8e",
          "Title": "sample string 2",
          "ReceivedDate": "2019-08-25T01:08:31.7451991+03:00",
          "State": 0,
          "Type": {
            "Code": 1,
            "Name": "sample string 2"
          },
          "Department": {
            "Id": "551037ab-3db7-476d-96e1-40158db4343c",
            "Name": "sample string 2"
          },
          "IsReaded": true,
          "SentDate": "2019-08-25T01:08:31.7461914+03:00",
          "NeedResign": true,
          "Direction": 0,
          "IsDeleted": true
        }
      ],
      "Direction": 0
    },
    {
      "Id": "752ae079-ce0b-44ae-a11b-a78f9512c752",
      "Contractor": {
        "Id": "8006ccb7-5215-4e4d-b80a-d69d59a56f20",
        "Name": "sample string 2",
        "Inn": "sample string 3",
        "Kpp": "sample string 4",
        "IsRoaming": true
      },
      "SentDate": "2019-08-25T01:08:31.7451991+03:00",
      "State": 0,
      "Documents": [
        {
          "Id": "3e00e546-3f2c-4faa-ad92-c5a38253fb8e",
          "Title": "sample string 2",
          "ReceivedDate": "2019-08-25T01:08:31.7451991+03:00",
          "State": 0,
          "Type": {
            "Code": 1,
            "Name": "sample string 2"
          },
          "Department": {
            "Id": "551037ab-3db7-476d-96e1-40158db4343c",
            "Name": "sample string 2"
          },
          "IsReaded": true,
          "SentDate": "2019-08-25T01:08:31.7461914+03:00",
          "NeedResign": true,
          "Direction": 0,
          "IsDeleted": true
        },
        {
          "Id": "3e00e546-3f2c-4faa-ad92-c5a38253fb8e",
          "Title": "sample string 2",
          "ReceivedDate": "2019-08-25T01:08:31.7451991+03:00",
          "State": 0,
          "Type": {
            "Code": 1,
            "Name": "sample string 2"
          },
          "Department": {
            "Id": "551037ab-3db7-476d-96e1-40158db4343c",
            "Name": "sample string 2"
          },
          "IsReaded": true,
          "SentDate": "2019-08-25T01:08:31.7461914+03:00",
          "NeedResign": true,
          "Direction": 0,
          "IsDeleted": true
        }
      ],
      "Direction": 0
    }
  ]
}

application/xml, text/xml

Пример:
<DocumentGroupsModel.DocumentGroupList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Taxnet.Transcrypt.Api20.Models">
  <Items>
    <DocumentGroupsModel.DocumentGroup>
      <Contractor>
        <Id>8006ccb7-5215-4e4d-b80a-d69d59a56f20</Id>
        <Inn>sample string 3</Inn>
        <IsRoaming>true</IsRoaming>
        <Kpp>sample string 4</Kpp>
        <Name>sample string 2</Name>
      </Contractor>
      <Direction>None</Direction>
      <Documents>
        <DocumentGroupsModel.Document>
          <Department>
            <Id>551037ab-3db7-476d-96e1-40158db4343c</Id>
            <Name>sample string 2</Name>
          </Department>
          <Direction>None</Direction>
          <Id>3e00e546-3f2c-4faa-ad92-c5a38253fb8e</Id>
          <IsDeleted>true</IsDeleted>
          <IsReaded>true</IsReaded>
          <NeedResign>true</NeedResign>
          <ReceivedDate>2019-08-25T01:08:31.7451991+03:00</ReceivedDate>
          <SentDate>2019-08-25T01:08:31.7461914+03:00</SentDate>
          <State>None</State>
          <Title>sample string 2</Title>
          <Type>
            <Code>1</Code>
            <Name>sample string 2</Name>
          </Type>
        </DocumentGroupsModel.Document>
        <DocumentGroupsModel.Document>
          <Department>
            <Id>551037ab-3db7-476d-96e1-40158db4343c</Id>
            <Name>sample string 2</Name>
          </Department>
          <Direction>None</Direction>
          <Id>3e00e546-3f2c-4faa-ad92-c5a38253fb8e</Id>
          <IsDeleted>true</IsDeleted>
          <IsReaded>true</IsReaded>
          <NeedResign>true</NeedResign>
          <ReceivedDate>2019-08-25T01:08:31.7451991+03:00</ReceivedDate>
          <SentDate>2019-08-25T01:08:31.7461914+03:00</SentDate>
          <State>None</State>
          <Title>sample string 2</Title>
          <Type>
            <Code>1</Code>
            <Name>sample string 2</Name>
          </Type>
        </DocumentGroupsModel.Document>
      </Documents>
      <Id>752ae079-ce0b-44ae-a11b-a78f9512c752</Id>
      <SentDate>2019-08-25T01:08:31.7451991+03:00</SentDate>
      <State>None</State>
    </DocumentGroupsModel.DocumentGroup>
    <DocumentGroupsModel.DocumentGroup>
      <Contractor>
        <Id>8006ccb7-5215-4e4d-b80a-d69d59a56f20</Id>
        <Inn>sample string 3</Inn>
        <IsRoaming>true</IsRoaming>
        <Kpp>sample string 4</Kpp>
        <Name>sample string 2</Name>
      </Contractor>
      <Direction>None</Direction>
      <Documents>
        <DocumentGroupsModel.Document>
          <Department>
            <Id>551037ab-3db7-476d-96e1-40158db4343c</Id>
            <Name>sample string 2</Name>
          </Department>
          <Direction>None</Direction>
          <Id>3e00e546-3f2c-4faa-ad92-c5a38253fb8e</Id>
          <IsDeleted>true</IsDeleted>
          <IsReaded>true</IsReaded>
          <NeedResign>true</NeedResign>
          <ReceivedDate>2019-08-25T01:08:31.7451991+03:00</ReceivedDate>
          <SentDate>2019-08-25T01:08:31.7461914+03:00</SentDate>
          <State>None</State>
          <Title>sample string 2</Title>
          <Type>
            <Code>1</Code>
            <Name>sample string 2</Name>
          </Type>
        </DocumentGroupsModel.Document>
        <DocumentGroupsModel.Document>
          <Department>
            <Id>551037ab-3db7-476d-96e1-40158db4343c</Id>
            <Name>sample string 2</Name>
          </Department>
          <Direction>None</Direction>
          <Id>3e00e546-3f2c-4faa-ad92-c5a38253fb8e</Id>
          <IsDeleted>true</IsDeleted>
          <IsReaded>true</IsReaded>
          <NeedResign>true</NeedResign>
          <ReceivedDate>2019-08-25T01:08:31.7451991+03:00</ReceivedDate>
          <SentDate>2019-08-25T01:08:31.7461914+03:00</SentDate>
          <State>None</State>
          <Title>sample string 2</Title>
          <Type>
            <Code>1</Code>
            <Name>sample string 2</Name>
          </Type>
        </DocumentGroupsModel.Document>
      </Documents>
      <Id>752ae079-ce0b-44ae-a11b-a78f9512c752</Id>
      <SentDate>2019-08-25T01:08:31.7451991+03:00</SentDate>
      <State>None</State>
    </DocumentGroupsModel.DocumentGroup>
  </Items>
  <NextPageUrl>sample string 1</NextPageUrl>
</DocumentGroupsModel.DocumentGroupList>