Informace o requestu

Odeslání zálohové faktury.

Příklad URL:
 v2.0/Mails/ProformaInvoice/Send

None.

Nastavení pro odeslání.

ProformaInvoiceEmailSettings
JménoPopisTypDoplňující informace
AttachmentIds

Id příloh faktury k odeslání.

 Collection of integer

Žádné.
DocumentId

Id dokumentu pro odeslání.

 integer

Required
EmailBody

Vlastní šablona e-mailu. Může obsahovat zástupné znaky. Je-li nevyplněná, použije se šablona z nastavení.

 string

Žádné.
EmailSubject

Vlastní předmět e-mailu. Je-li nevyplněný, použije se předmět z nastavení.

 string

Žádné.
Method

Typ zaslání e-mailu - pdf příloha nebo faktura odkazem. Je-li nevyplněn, použije se hodnota z nastavení.

 SendMethodType

Žádné.
OtherRecipients

Seznam dalších příjemců.

 Collection of string

Kolekce by měla obsahovat 0 až 5 prvků
ReportLanuage

Jazyk dokumentu

 Language

Žádné.
SendAttachment

Připojit i přílohu dokladu, má-li nějakou.

 boolean

Žádné.
SendToAccountant

Poslat účetní. E-mail i šablona účetní je definována v nastavení aplikace.

 boolean

Required
SendToPartner

Poslat partnerovi (dodavateli/příjemci).

 boolean

Required
SendToSelf

Poslat kopii na firemní e-mail.

 boolean

Required
Ukážka: 
{
  "AttachmentIds": [
    1
  ],
  "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
}
Ukážka: 
<ProformaInvoiceEmailSettings 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>
  <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>

Informace o response

EmailSendResult
JménoPopisTypDoplňující informace
NotSent

Neodeslané emaily

 Collection of string

Žádné.
Sent

Odeslané emaily

 Collection of string

Žádné.
Ukážka: 
{
  "NotSent": [
    "sample string 1"
  ],
  "Sent": [
    "sample string 1"
  ]
}
Ukážka: 
<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>