Request Information

Send a proforma invoice.

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

None.

E-mail settings.

ProformaInvoiceEmailSettings
NameDescriptionTypeAdditional information
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.

Method

E-mail send method - pdf attachment or invoice link. If not set, the value from your settings will be used.

SendMethodType

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.

SendToAccountant

Send to acountant. The accountant's E-mail and mail template are specified in the application settings.

boolean

Required

SendToPartner

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

boolean

Required

SendToSelf

Send a copy of the e-mail to your company address.

boolean

Required

Sample:
{
  "DocumentId": 1,
  "EmailBody": "sample string 2",
  "EmailSubject": "sample string 3",
  "OtherRecipients": [
    "sample string 1"
  ],
  "ReportLanuage": 1,
  "SendAttachment": true,
  "SendToAccountant": true,
  "SendToSelf": true,
  "SendToPartner": true,
  "Method": 0
}
Sample:
<ProformaInvoiceEmailSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.Email">
  <DocumentId>1</DocumentId>
  <EmailBody>sample string 2</EmailBody>
  <EmailSubject>sample string 3</EmailSubject>
  <Method>Pdf</Method>
  <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>
  <SendToAccountant>true</SendToAccountant>
  <SendToPartner>true</SendToPartner>
  <SendToSelf>true</SendToSelf>
</ProformaInvoiceEmailSettings>

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>