GET api/customers/{id}/documents

Метод для получения справочника "Документов клиента"

Полный URL-адрес запроса: https://sfa-api.ddapp.biz/api/customers/{id}/documents

  Для этого метода требуется авторизация

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

URL параметры

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

Уникальный идентификатор "Клиента"

 string

Required
Fields

Список дополнительных полей, которые необходимо вернуть

 string

Нет
Sort

Поле по которому необходима сортировка результатов

 string

Нет
Page

Номер страницы (начиная с 1)

 integer

Интервал: с 1 по 2147483646
PageSize

Кол-во записей на странице (макс. 50)

 integer

Интервал: с 1 по 50

Тело запроса

Нет параметров в теле запроса

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

PagedResponseModelOfDocumentModel
НазваниеОписаниеТип данныхДополнительная информация
Data

Collection of DocumentModel

Нет
Pagination

PaginationModel

Нет

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

{
  "data": [
    {
      "id": "ea26cd8d-30da-4352-83bc-a2a0a35273c9",
      "vendorId": "sample string 2",
      "number": "sample string 3",
      "name": "sample string 4",
      "type": {
        "id": "92d67b65-1168-4bd7-83a2-5a1dc89dba7c",
        "name": "sample string 2"
      },
      "documentDate": "2024-11-22T00:41:23.5714136Z",
      "dateFrom": "2024-11-22T00:41:23.5714136Z",
      "dateTill": "2024-11-22T00:41:23.5714136Z",
      "sum": 1.0,
      "downloadUrl": "sample string 5",
      "active": true
    },
    {
      "id": "ea26cd8d-30da-4352-83bc-a2a0a35273c9",
      "vendorId": "sample string 2",
      "number": "sample string 3",
      "name": "sample string 4",
      "type": {
        "id": "92d67b65-1168-4bd7-83a2-5a1dc89dba7c",
        "name": "sample string 2"
      },
      "documentDate": "2024-11-22T00:41:23.5714136Z",
      "dateFrom": "2024-11-22T00:41:23.5714136Z",
      "dateTill": "2024-11-22T00:41:23.5714136Z",
      "sum": 1.0,
      "downloadUrl": "sample string 5",
      "active": true
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 2,
    "totalCount": 3,
    "totalPages": 4,
    "prevPageLink": "sample string 5",
    "nextPageLink": "sample string 6"
  }
}

<PagedResponseModelOfDocumentModelCyyDCEjL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Miscellaneous.Pagination">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Documents">
    <d2p1:DocumentModel>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:DateFrom>2024-11-22T00:41:23.5714136+00:00</d2p1:DateFrom>
      <d2p1:DateTill>2024-11-22T00:41:23.5714136+00:00</d2p1:DateTill>
      <d2p1:DocumentDate>2024-11-22T00:41:23.5714136+00:00</d2p1:DocumentDate>
      <d2p1:DownloadUrl>sample string 5</d2p1:DownloadUrl>
      <d2p1:Id>ea26cd8d-30da-4352-83bc-a2a0a35273c9</d2p1:Id>
      <d2p1:Name>sample string 4</d2p1:Name>
      <d2p1:Number>sample string 3</d2p1:Number>
      <d2p1:Sum>1</d2p1:Sum>
      <d2p1:Type xmlns:d4p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Documents.Types">
        <d4p1:Id>92d67b65-1168-4bd7-83a2-5a1dc89dba7c</d4p1:Id>
        <d4p1:Name>sample string 2</d4p1:Name>
      </d2p1:Type>
      <d2p1:VendorId>sample string 2</d2p1:VendorId>
    </d2p1:DocumentModel>
    <d2p1:DocumentModel>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:DateFrom>2024-11-22T00:41:23.5714136+00:00</d2p1:DateFrom>
      <d2p1:DateTill>2024-11-22T00:41:23.5714136+00:00</d2p1:DateTill>
      <d2p1:DocumentDate>2024-11-22T00:41:23.5714136+00:00</d2p1:DocumentDate>
      <d2p1:DownloadUrl>sample string 5</d2p1:DownloadUrl>
      <d2p1:Id>ea26cd8d-30da-4352-83bc-a2a0a35273c9</d2p1:Id>
      <d2p1:Name>sample string 4</d2p1:Name>
      <d2p1:Number>sample string 3</d2p1:Number>
      <d2p1:Sum>1</d2p1:Sum>
      <d2p1:Type xmlns:d4p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Documents.Types">
        <d4p1:Id>92d67b65-1168-4bd7-83a2-5a1dc89dba7c</d4p1:Id>
        <d4p1:Name>sample string 2</d4p1:Name>
      </d2p1:Type>
      <d2p1:VendorId>sample string 2</d2p1:VendorId>
    </d2p1:DocumentModel>
  </Data>
  <Pagination>
    <NextPageLink>sample string 6</NextPageLink>
    <Page>1</Page>
    <PageSize>2</PageSize>
    <PrevPageLink>sample string 5</PrevPageLink>
    <TotalCount>3</TotalCount>
    <TotalPages>4</TotalPages>
  </Pagination>
</PagedResponseModelOfDocumentModelCyyDCEjL>