Request Information

Send a sales order.

Example URL:
v2.0/Mails/SalesOrder/Send

None.

E-mail settings.

SalesOrderEmailSettings
NameDescriptionTypeAdditional information
AttachmentIds

Sales order attachment Ids.

Collection of integer

None.

DocumentId

Id of the document to send.

integer

Required

EmailBody

Custom e-mail body. Can contain placeholders. If not set, the default from your settings will be used.

string

None.

EmailSubject

Custom e-mail subject. If not set, the default from your settings will be used.

string

None.

OtherRecipients

List of other recipients.

Collection of string

Collection with length within range 0 and 5.

ReportLanuage

Document language

Language

None.

SendAttachment

Include the document's attachment if it has one.

boolean

None.

SendToPartner

Send to the partner (purchaser/supplier) specified on the document.

boolean

Required

Sample:
{
  "AttachmentIds": [
    1
  ],
  "DocumentId": 1,
  "EmailBody": "sample string 2",
  "EmailSubject": "sample string 3",
  "OtherRecipients": [
    "sample string 1"
  ],
  "ReportLanuage": 1,
  "SendAttachment": true,
  "SendToPartner": true
}
Sample:
<SalesOrderEmailSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.Email">
  <AttachmentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
  </AttachmentIds>
  <DocumentId>1</DocumentId>
  <EmailBody>sample string 2</EmailBody>
  <EmailSubject>sample string 3</EmailSubject>
  <OtherRecipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
  </OtherRecipients>
  <ReportLanuage>Cz</ReportLanuage>
  <SendAttachment>true</SendAttachment>
  <SendToPartner>true</SendToPartner>
</SalesOrderEmailSettings>

Response Information

EmailSendResult
NameDescriptionTypeAdditional information
NotSent

Emails not sent

Collection of string

None.

Sent

Emails sent

Collection of string

None.

Sample:
{
  "NotSent": [
    "sample string 1"
  ],
  "Sent": [
    "sample string 1"
  ]
}
Sample:
<EmailSendResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.Version3.Email">
  <NotSent xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
  </NotSent>
  <Sent xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
  </Sent>
</EmailSendResult>