POST api/DocumentLink

create document

Request Information

URI Parameters

None.

Body Parameters

Document model

DocumentVM
NameDescriptionTypeAdditional information
document

Document

None.

Binary

Collection of byte

None.

Request Formats

application/json, text/json

Sample:
{
  "document": {
    "AccountCode": "sample string 1",
    "AccountID": "sample string 2",
    "ID": "sample string 3",
    "HID": "sample string 4",
    "CreatedDate": "2021-04-15T06:40:24.6088812+02:00",
    "NewsType": 1,
    "SecurityLevel": 6,
    "Status": 1,
    "Subject": "sample string 7",
    "FileName": "sample string 8",
    "MessageIDBody": "sample string 9",
    "MessageIDDocument": "sample string 10",
    "ProjectNumber": "sample string 11",
    "OrderNumber": "sample string 12",
    "IsBinaryServiceEnabled": true,
    "Type": 1,
    "CreditorNumber": "sample string 13",
    "DebtorNumber": "sample string 14",
    "Category": "sample string 15",
    "OurRef": "sample string 16",
    "YourRef": "sample string 17",
    "TransactionKey": "sample string 18",
    "Action": "sample string 19"
  },
  "Binary": "QEA="
}

application/xml, text/xml

Sample:
<DocumentVM xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <document>
    <TransactionKey>sample string 18</TransactionKey>
    <Action>sample string 19</Action>
    <AccountCode>sample string 1</AccountCode>
    <AccountID>sample string 2</AccountID>
    <ID>sample string 3</ID>
    <HID>sample string 4</HID>
    <CreatedDate>2021-04-15T06:40:24.6088812+02:00</CreatedDate>
    <NewsType>1</NewsType>
    <SecurityLevel>6</SecurityLevel>
    <Status>1</Status>
    <Subject>sample string 7</Subject>
    <FileName>sample string 8</FileName>
    <MessageIDBody>sample string 9</MessageIDBody>
    <MessageIDDocument>sample string 10</MessageIDDocument>
    <ProjectNumber>sample string 11</ProjectNumber>
    <OrderNumber>sample string 12</OrderNumber>
    <IsBinaryServiceEnabled>true</IsBinaryServiceEnabled>
    <Type>1</Type>
    <CreditorNumber>sample string 13</CreditorNumber>
    <DebtorNumber>sample string 14</DebtorNumber>
    <Category>sample string 15</Category>
    <OurRef>sample string 16</OurRef>
    <YourRef>sample string 17</YourRef>
  </document>
  <Binary>QEA=</Binary>
</DocumentVM>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Document

Document
NameDescriptionTypeAdditional information
AccountCode

string

None.

AccountID

string

None.

ID

string

None.

HID

string

None.

CreatedDate

date

None.

NewsType

integer

None.

SecurityLevel

integer

None.

Status

integer

None.

Subject

string

None.

FileName

string

None.

MessageIDBody

string

None.

MessageIDDocument

string

None.

ProjectNumber

string

None.

OrderNumber

string

None.

IsBinaryServiceEnabled

boolean

None.

Type

integer

None.

CreditorNumber

string

None.

DebtorNumber

string

None.

Category

string

None.

OurRef

string

None.

YourRef

string

None.

TransactionKey

string

None.

Action

string

None.

Response Formats

application/json, text/json

Sample:
{
  "AccountCode": "sample string 1",
  "AccountID": "sample string 2",
  "ID": "sample string 3",
  "HID": "sample string 4",
  "CreatedDate": "2021-04-15T06:40:24.6244705+02:00",
  "NewsType": 1,
  "SecurityLevel": 6,
  "Status": 1,
  "Subject": "sample string 7",
  "FileName": "sample string 8",
  "MessageIDBody": "sample string 9",
  "MessageIDDocument": "sample string 10",
  "ProjectNumber": "sample string 11",
  "OrderNumber": "sample string 12",
  "IsBinaryServiceEnabled": true,
  "Type": 1,
  "CreditorNumber": "sample string 13",
  "DebtorNumber": "sample string 14",
  "Category": "sample string 15",
  "OurRef": "sample string 16",
  "YourRef": "sample string 17",
  "TransactionKey": "sample string 18",
  "Action": "sample string 19"
}

application/xml, text/xml

Sample:
<Document xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <TransactionKey>sample string 18</TransactionKey>
  <Action>sample string 19</Action>
  <AccountCode>sample string 1</AccountCode>
  <AccountID>sample string 2</AccountID>
  <ID>sample string 3</ID>
  <HID>sample string 4</HID>
  <CreatedDate>2021-04-15T06:40:24.6244705+02:00</CreatedDate>
  <NewsType>1</NewsType>
  <SecurityLevel>6</SecurityLevel>
  <Status>1</Status>
  <Subject>sample string 7</Subject>
  <FileName>sample string 8</FileName>
  <MessageIDBody>sample string 9</MessageIDBody>
  <MessageIDDocument>sample string 10</MessageIDDocument>
  <ProjectNumber>sample string 11</ProjectNumber>
  <OrderNumber>sample string 12</OrderNumber>
  <IsBinaryServiceEnabled>true</IsBinaryServiceEnabled>
  <Type>1</Type>
  <CreditorNumber>sample string 13</CreditorNumber>
  <DebtorNumber>sample string 14</DebtorNumber>
  <Category>sample string 15</Category>
  <OurRef>sample string 16</OurRef>
  <YourRef>sample string 17</YourRef>
</Document>