POST api/document

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Number	string	None.
Date	date	None.
FileCode	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Number": "sample string 1",
  "Date": "2025-05-30T07:17:54",
  "FileCode": "sample string 3"
}

text/html

Sample:

{"Number":"sample string 1","Date":"2025-05-30T07:17:54","FileCode":"sample string 3"}

application/xml, text/xml

Sample:

<CreateDocumentRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Metib.Modules.Factoring.Api.Models.Requests">
  <Date>2025-05-30T07:17:54.3287006+03:00</Date>
  <FileCode>sample string 3</FileCode>
  <Number>sample string 1</Number>
</CreateDocumentRequestDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DocumentDTO

Name	Type	Additional information
Organization	OrganizationReferenceDTO	None.
Counterparty	OrganizationReferenceDTO	None.
Number	string	None.
Date	date	None.
TypeName	string	None.
TypeTitle	string	None.
Title	string	None.
User	string	None.
Summ	decimal number	None.
File	FileModel	None.
Flows	Collection of DocumentFlowDTO	None.
Signatures	Collection of DocumentSignatureDTO	None.
Parties	Collection of OrganizationReferenceDTO	None.
ID	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Organization": {
    "Title": "sample string 1",
    "Inn": "sample string 2",
    "Kpp": "sample string 3",
    "ID": 4
  },
  "Counterparty": {
    "Title": "sample string 1",
    "Inn": "sample string 2",
    "Kpp": "sample string 3",
    "ID": 4
  },
  "Number": "sample string 1",
  "Date": "2025-05-30T07:17:54+03:00",
  "TypeName": "sample string 3",
  "TypeTitle": "sample string 4",
  "Title": "sample string 5",
  "User": "sample string 6",
  "Summ": 1.0,
  "File": {
    "ID": 1,
    "Identifier": "sample string 2",
    "Code": "sample string 3",
    "FileName": "sample string 4",
    "Size": 5
  },
  "Flows": [
    {
      "Type": "sample string 1",
      "User": "sample string 2",
      "Organization": "sample string 3",
      "Date": "2025-05-30T07:17:54+03:00",
      "RefID": 1,
      "Comment": "sample string 5",
      "ID": 6
    },
    {
      "Type": "sample string 1",
      "User": "sample string 2",
      "Organization": "sample string 3",
      "Date": "2025-05-30T07:17:54+03:00",
      "RefID": 1,
      "Comment": "sample string 5",
      "ID": 6
    }
  ],
  "Signatures": [
    {
      "File": {
        "ID": 1,
        "Identifier": "sample string 2",
        "Code": "sample string 3",
        "FileName": "sample string 4",
        "Size": 5
      },
      "User": "sample string 1",
      "Organization": "sample string 2",
      "Date": "2025-05-30T07:17:54+03:00",
      "ID": 4
    },
    {
      "File": {
        "ID": 1,
        "Identifier": "sample string 2",
        "Code": "sample string 3",
        "FileName": "sample string 4",
        "Size": 5
      },
      "User": "sample string 1",
      "Organization": "sample string 2",
      "Date": "2025-05-30T07:17:54+03:00",
      "ID": 4
    }
  ],
  "Parties": [
    {
      "Title": "sample string 1",
      "Inn": "sample string 2",
      "Kpp": "sample string 3",
      "ID": 4
    },
    {
      "Title": "sample string 1",
      "Inn": "sample string 2",
      "Kpp": "sample string 3",
      "ID": 4
    }
  ],
  "ID": 7
}

text/html

Sample:

{"Organization":{"Title":"sample string 1","Inn":"sample string 2","Kpp":"sample string 3","ID":4},"Counterparty":{"Title":"sample string 1","Inn":"sample string 2","Kpp":"sample string 3","ID":4},"Number":"sample string 1","Date":"2025-05-30T07:17:54+03:00","TypeName":"sample string 3","TypeTitle":"sample string 4","Title":"sample string 5","User":"sample string 6","Summ":1.0,"File":{"ID":1,"Identifier":"sample string 2","Code":"sample string 3","FileName":"sample string 4","Size":5},"Flows":[{"Type":"sample string 1","User":"sample string 2","Organization":"sample string 3","Date":"2025-05-30T07:17:54+03:00","RefID":1,"Comment":"sample string 5","ID":6},{"Type":"sample string 1","User":"sample string 2","Organization":"sample string 3","Date":"2025-05-30T07:17:54+03:00","RefID":1,"Comment":"sample string 5","ID":6}],"Signatures":[{"File":{"ID":1,"Identifier":"sample string 2","Code":"sample string 3","FileName":"sample string 4","Size":5},"User":"sample string 1","Organization":"sample string 2","Date":"2025-05-30T07:17:54+03:00","ID":4},{"File":{"ID":1,"Identifier":"sample string 2","Code":"sample string 3","FileName":"sample string 4","Size":5},"User":"sample string 1","Organization":"sample string 2","Date":"2025-05-30T07:17:54+03:00","ID":4}],"Parties":[{"Title":"sample string 1","Inn":"sample string 2","Kpp":"sample string 3","ID":4},{"Title":"sample string 1","Inn":"sample string 2","Kpp":"sample string 3","ID":4}],"ID":7}

application/xml, text/xml

Sample:

<DocumentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Metib.Modules.Factoring.Api.DTO">
  <ID xmlns="http://schemas.datacontract.org/2004/07/Metib.Kernel.Api">7</ID>
  <Counterparty xmlns:d2p1="http://schemas.datacontract.org/2004/07/Metib.Kernel.Api.DTO">
    <ID xmlns="http://schemas.datacontract.org/2004/07/Metib.Kernel.Api">4</ID>
    <d2p1:Inn>sample string 2</d2p1:Inn>
    <d2p1:Kpp>sample string 3</d2p1:Kpp>
    <d2p1:Title>sample string 1</d2p1:Title>
  </Counterparty>
  <Date xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-05-30T04:17:54.3287006Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>180</d2p1:OffsetMinutes>
  </Date>
  <File xmlns:d2p1="http://schemas.datacontract.org/2004/07/Metib.Common.Models">
    <d2p1:Code>sample string 3</d2p1:Code>
    <d2p1:FileName>sample string 4</d2p1:FileName>
    <d2p1:ID>1</d2p1:ID>
    <d2p1:Identifier>sample string 2</d2p1:Identifier>
    <d2p1:Size>5</d2p1:Size>
  </File>
  <Flows>
    <DocumentFlowDTO>
      <ID xmlns="http://schemas.datacontract.org/2004/07/Metib.Kernel.Api">6</ID>
      <Comment>sample string 5</Comment>
      <Date xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-05-30T04:17:54.3287006Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>180</d4p1:OffsetMinutes>
      </Date>
      <Organization>sample string 3</Organization>
      <RefID>1</RefID>
      <Type>sample string 1</Type>
      <User>sample string 2</User>
    </DocumentFlowDTO>
    <DocumentFlowDTO>
      <ID xmlns="http://schemas.datacontract.org/2004/07/Metib.Kernel.Api">6</ID>
      <Comment>sample string 5</Comment>
      <Date xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-05-30T04:17:54.3287006Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>180</d4p1:OffsetMinutes>
      </Date>
      <Organization>sample string 3</Organization>
      <RefID>1</RefID>
      <Type>sample string 1</Type>
      <User>sample string 2</User>
    </DocumentFlowDTO>
  </Flows>
  <Number>sample string 1</Number>
  <Organization xmlns:d2p1="http://schemas.datacontract.org/2004/07/Metib.Kernel.Api.DTO">
    <ID xmlns="http://schemas.datacontract.org/2004/07/Metib.Kernel.Api">4</ID>
    <d2p1:Inn>sample string 2</d2p1:Inn>
    <d2p1:Kpp>sample string 3</d2p1:Kpp>
    <d2p1:Title>sample string 1</d2p1:Title>
  </Organization>
  <Parties xmlns:d2p1="http://schemas.datacontract.org/2004/07/Metib.Kernel.Api.DTO">
    <d2p1:OrganizationReferenceDTO>
      <ID xmlns="http://schemas.datacontract.org/2004/07/Metib.Kernel.Api">4</ID>
      <d2p1:Inn>sample string 2</d2p1:Inn>
      <d2p1:Kpp>sample string 3</d2p1:Kpp>
      <d2p1:Title>sample string 1</d2p1:Title>
    </d2p1:OrganizationReferenceDTO>
    <d2p1:OrganizationReferenceDTO>
      <ID xmlns="http://schemas.datacontract.org/2004/07/Metib.Kernel.Api">4</ID>
      <d2p1:Inn>sample string 2</d2p1:Inn>
      <d2p1:Kpp>sample string 3</d2p1:Kpp>
      <d2p1:Title>sample string 1</d2p1:Title>
    </d2p1:OrganizationReferenceDTO>
  </Parties>
  <Signatures>
    <DocumentSignatureDTO>
      <ID xmlns="http://schemas.datacontract.org/2004/07/Metib.Kernel.Api">4</ID>
      <Date xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-05-30T04:17:54.3287006Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>180</d4p1:OffsetMinutes>
      </Date>
      <File xmlns:d4p1="http://schemas.datacontract.org/2004/07/Metib.Common.Models">
        <d4p1:Code>sample string 3</d4p1:Code>
        <d4p1:FileName>sample string 4</d4p1:FileName>
        <d4p1:ID>1</d4p1:ID>
        <d4p1:Identifier>sample string 2</d4p1:Identifier>
        <d4p1:Size>5</d4p1:Size>
      </File>
      <Organization>sample string 2</Organization>
      <User>sample string 1</User>
    </DocumentSignatureDTO>
    <DocumentSignatureDTO>
      <ID xmlns="http://schemas.datacontract.org/2004/07/Metib.Kernel.Api">4</ID>
      <Date xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-05-30T04:17:54.3287006Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>180</d4p1:OffsetMinutes>
      </Date>
      <File xmlns:d4p1="http://schemas.datacontract.org/2004/07/Metib.Common.Models">
        <d4p1:Code>sample string 3</d4p1:Code>
        <d4p1:FileName>sample string 4</d4p1:FileName>
        <d4p1:ID>1</d4p1:ID>
        <d4p1:Identifier>sample string 2</d4p1:Identifier>
        <d4p1:Size>5</d4p1:Size>
      </File>
      <Organization>sample string 2</Organization>
      <User>sample string 1</User>
    </DocumentSignatureDTO>
  </Signatures>
  <Summ>1</Summ>
  <Title>sample string 5</Title>
  <TypeName>sample string 3</TypeName>
  <TypeTitle>sample string 4</TypeTitle>
  <User>sample string 6</User>
</DocumentDTO>