GET api/documents/{id}

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

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

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

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

URL параметры

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

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

 string

Required
fields

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

 string

Нет

Тело запроса

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

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

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

globally unique identifier

Нет
VendorId

string

Нет
Number

string

Нет
Name

string

Поддерживает сортировку
Type

DocumentTypeModel

Нет
DocumentDate

date

Нет
DateFrom

date

Нет
DateTill

date

Нет
Sum

decimal number

Нет
DownloadUrl

string

Нет
Active

boolean

Нет

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

{
  "id": "6ea34abc-a2e6-43b7-8542-543c5fe8d750",
  "vendorId": "sample string 2",
  "number": "sample string 3",
  "name": "sample string 4",
  "type": {
    "id": "291e09bf-e7cb-44ca-a9ea-de2467118b0c",
    "name": "sample string 2"
  },
  "documentDate": "2025-04-03T05:21:32.1761766Z",
  "dateFrom": "2025-04-03T05:21:32.1761766Z",
  "dateTill": "2025-04-03T05:21:32.1761766Z",
  "sum": 1.0,
  "downloadUrl": "sample string 5",
  "active": true
}

<DocumentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Documents">
  <Active>true</Active>
  <DateFrom>2025-04-03T05:21:32.1761766+00:00</DateFrom>
  <DateTill>2025-04-03T05:21:32.1761766+00:00</DateTill>
  <DocumentDate>2025-04-03T05:21:32.1761766+00:00</DocumentDate>
  <DownloadUrl>sample string 5</DownloadUrl>
  <Id>6ea34abc-a2e6-43b7-8542-543c5fe8d750</Id>
  <Name>sample string 4</Name>
  <Number>sample string 3</Number>
  <Sum>1</Sum>
  <Type xmlns:d2p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Documents.Types">
    <d2p1:Id>291e09bf-e7cb-44ca-a9ea-de2467118b0c</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </Type>
  <VendorId>sample string 2</VendorId>
</DocumentModel>