GET v2.0/document/{id}

Получение карточки документа (без содержимого документа).

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Идентификатор документа.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Карточка документа.

Korus.Eds.Api.Document
NameDescriptionTypeAdditional information
Id

integer

None.

TypeId

integer

None.

TypeName

string

None.

DocumentTypeCode

string

None.

Description

string

None.

BarcodeType

Korus.Eds.Core.BarcodeType

None.

BarcodeValue

string

None.

SenderId

integer

None.

ReceiverId

integer

None.

ParticipantId

integer

None.

ParticipantName

string

None.

Status

Korus.Eds.Core.DocumentStatus

None.

Date

date

None.

RequestSign

boolean

None.

Number

string

None.

NetSum

decimal number

None.

VatSum

decimal number

None.

TotalSum

decimal number

None.

Actions

Korus.Eds.Core.Actions

None.

IsMarked

boolean

None.

Created

date

None.

SendDate

date

None.

ReceiveDate

date

None.

IsDocflowCompleted

boolean

None.

Comment

string

None.

ContractNumber

string

None.

ContractDate

date

None.

Type

Korus.Eds.Core.TransportDocumentType

None.

FormType

Korus.Eds.Core.DocumentFormType

None.

SellerCode

string

None.

BuyerCode

string

None.

FormatVersion

string

None.

FormatCode

string

None.

Filename

string

None.

RevokeReason

string

None.

ContractDescription

string

None.

IsRoaming

boolean

None.

Content

Korus.Eds.Api.FileContent

None.

IsPrintable

boolean

None.

Relations

Collection of Korus.Eds.Api.DocumentRelation

None.

StatusName

string

None.

RejectReason

string

None.

SenderName

string

None.

ReceiverName

string

None.

ExistRouteSigner

boolean

None.

DocumentRelationType

Korus.Eds.Core.DocumentRelationType

None.

Attachments

Collection of Korus.Eds.Api.Attachment

None.

StatusChanged

date

None.

PackageId

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "typeId": 2,
  "typeName": "sample string 3",
  "documentTypeCode": "sample string 4",
  "description": "sample string 5",
  "barcodeType": 0,
  "barcodeValue": "sample string 6",
  "senderId": 7,
  "receiverId": 8,
  "participantId": 9,
  "participantName": "sample string 10",
  "status": 0,
  "date": "2025-04-29T16:57:21.4497086+03:00",
  "requestSign": true,
  "number": "sample string 13",
  "netSum": 1.0,
  "vatSum": 1.0,
  "totalSum": 1.0,
  "actions": 0,
  "isMarked": true,
  "created": "2025-04-29T16:57:21.4497086+03:00",
  "sendDate": "2025-04-29T16:57:21.4497086+03:00",
  "receiveDate": "2025-04-29T16:57:21.4497086+03:00",
  "isDocflowCompleted": true,
  "comment": "sample string 17",
  "contractNumber": "sample string 18",
  "contractDate": "2025-04-29T16:57:21.4497086+03:00",
  "type": 1,
  "formType": 0,
  "sellerCode": "sample string 19",
  "buyerCode": "sample string 20",
  "formatVersion": "sample string 21",
  "formatCode": "sample string 22",
  "filename": "sample string 23",
  "revokeReason": "sample string 24",
  "contractDescription": "sample string 25",
  "isRoaming": true,
  "content": {
    "filename": "sample string 1",
    "mimeType": "sample string 2",
    "content": "QEA="
  },
  "isPrintable": true,
  "relations": [
    {
      "id": 1,
      "parentId": 1,
      "relation": 0,
      "description": "sample string 2"
    },
    {
      "id": 1,
      "parentId": 1,
      "relation": 0,
      "description": "sample string 2"
    }
  ],
  "statusName": "sample string 28",
  "rejectReason": "sample string 29",
  "senderName": "sample string 30",
  "receiverName": "sample string 31",
  "existRouteSigner": true,
  "documentRelationType": 0,
  "attachments": [
    {
      "id": 1,
      "uuid": "sample string 2",
      "documentId": 3,
      "filename": "sample string 4",
      "mimeType": "sample string 5",
      "content": "QEA="
    },
    {
      "id": 1,
      "uuid": "sample string 2",
      "documentId": 3,
      "filename": "sample string 4",
      "mimeType": "sample string 5",
      "content": "QEA="
    }
  ],
  "statusChanged": "2025-04-29T16:57:21.4497086+03:00",
  "packageId": 1
}

application/xml, text/xml

Sample:
<Document xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Korus.Eds.Api">
  <Actions>None</Actions>
  <Attachments>
    <Attachment>
      <Content>QEA=</Content>
      <DocumentId>3</DocumentId>
      <Filename>sample string 4</Filename>
      <Id>1</Id>
      <MimeType>sample string 5</MimeType>
      <Uuid>sample string 2</Uuid>
    </Attachment>
    <Attachment>
      <Content>QEA=</Content>
      <DocumentId>3</DocumentId>
      <Filename>sample string 4</Filename>
      <Id>1</Id>
      <MimeType>sample string 5</MimeType>
      <Uuid>sample string 2</Uuid>
    </Attachment>
  </Attachments>
  <BarcodeType>None</BarcodeType>
  <BarcodeValue>sample string 6</BarcodeValue>
  <BuyerCode>sample string 20</BuyerCode>
  <Comment>sample string 17</Comment>
  <Content>
    <Content>QEA=</Content>
    <Filename>sample string 1</Filename>
    <MimeType>sample string 2</MimeType>
  </Content>
  <ContractDate>2025-04-29T16:57:21.4497086+03:00</ContractDate>
  <ContractDescription>sample string 25</ContractDescription>
  <ContractNumber>sample string 18</ContractNumber>
  <Created>2025-04-29T16:57:21.4497086+03:00</Created>
  <Date>2025-04-29T16:57:21.4497086+03:00</Date>
  <Description>sample string 5</Description>
  <DocumentRelationType>Productive</DocumentRelationType>
  <DocumentTypeCode>sample string 4</DocumentTypeCode>
  <ExistRouteSigner>true</ExistRouteSigner>
  <Filename>sample string 23</Filename>
  <FormType>Other</FormType>
  <FormatCode>sample string 22</FormatCode>
  <FormatVersion>sample string 21</FormatVersion>
  <Id>1</Id>
  <IsDocflowCompleted>true</IsDocflowCompleted>
  <IsMarked>true</IsMarked>
  <IsPrintable>true</IsPrintable>
  <IsRoaming>true</IsRoaming>
  <NetSum>1</NetSum>
  <Number>sample string 13</Number>
  <PackageId>1</PackageId>
  <ParticipantId>9</ParticipantId>
  <ParticipantName>sample string 10</ParticipantName>
  <ReceiveDate>2025-04-29T16:57:21.4497086+03:00</ReceiveDate>
  <ReceiverId>8</ReceiverId>
  <ReceiverName>sample string 31</ReceiverName>
  <RejectReason>sample string 29</RejectReason>
  <Relations>
    <DocumentRelation>
      <Description>sample string 2</Description>
      <Id>1</Id>
      <ParentId>1</ParentId>
      <Relation>Other</Relation>
    </DocumentRelation>
    <DocumentRelation>
      <Description>sample string 2</Description>
      <Id>1</Id>
      <ParentId>1</ParentId>
      <Relation>Other</Relation>
    </DocumentRelation>
  </Relations>
  <RequestSign>true</RequestSign>
  <RevokeReason>sample string 24</RevokeReason>
  <SellerCode>sample string 19</SellerCode>
  <SendDate>2025-04-29T16:57:21.4497086+03:00</SendDate>
  <SenderId>7</SenderId>
  <SenderName>sample string 30</SenderName>
  <Status>None</Status>
  <StatusChanged>2025-04-29T16:57:21.4497086+03:00</StatusChanged>
  <StatusName>sample string 28</StatusName>
  <TotalSum>1</TotalSum>
  <Type>ReceiveNotice</Type>
  <TypeId>2</TypeId>
  <TypeName>sample string 3</TypeName>
  <VatSum>1</VatSum>
</Document>