Versions Compared

Old Version 37

changes.mady.by.user Bettina Borces

Saved on

compared with

New Version Current

changes.mady.by.user Min Zeng

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


This specifies all the fields associated with Invoices that are to be e-maileddata structure includes the invoice email information such as sent by user, email template, email type and recipients. 

Format


Panel
titlePwsInvoiceEmailSettings

Elements


Element

Data Type

Required?

Default

Description

Sample Data

EmailFromUserIdentity

PwsUserRef [1]

On Insert: Yes

On Update: Yes

The user identity that will be assigned to the "From" field in the invoice email. Click here for more information.


EmailInvoiceTemplateIdentity

PwsInvoiceTemplateRef

On Insert: Yes

On Update: Yes

The invoice email template that will be used for this invoice. Click here for more information.


InvoiceEmailEnabledFlag

Boolean

On Insert: Yes

On Update: Yes

A setting of 'true' indicates emailing invoices is enabled for this installation

true
/false
InvoiceEmailType
String (1)
On Insert: Yes
On Update: Yes
The invoice email type
"P" to include invoice as a PDF
"H" to embed invoice as HTML in email
"W" to upload invoice to project workspaces and include a link in the email 
P
Recipients
PwsInvoiceEmailRecipient [1..100]
On Insert: Yes
On Update: Yes
The recipient(s) of the invoice email. Click here for more information
Note: The list is limited to 10 recipients per type ("To", "CC", "BCC"). If more than 10 recipients of a specified type are specified the list will be truncated and a warning will be generated.


Usage Example(s)

 Code Block
languagexml
titlePwsInvoiceEmailSettings
collapsetrue
                     <b:InvoiceEmailSettings>
                        <b:EmailFromUserIdentity>
                           <b:UserDisplayName>Betty Smith</b:UserDisplayName>
                           <b:UserId i:nil="true"/>
  <InvoiceEmailSettings>                         <b:UserReferenceSystemId>Partner - <EmailFromUserIdentity>01</b:UserReferenceSystemId>
                           <PwsUserRef><b:UserUid>1152921504607011056</b:UserUid>
                        </b:EmailFromUserIdentity>
                        <b:EmailInvoiceTemplateIdentity>
                           <b:InvoiceTemplateId i:nil="true"/>
                           <EmailInvoiceTemplateIdentity><b:InvoiceTemplateName>E001</b:InvoiceTemplateName>
                           <PwsInvoiceTemplateRef><b:InvoiceTemplateUid>1152921504606878906</b:InvoiceTemplateUid>
                        </b:EmailInvoiceTemplateIdentity>
                        <InvoiceEmailEnabledFlag>true<<b:InvoiceEmailEnabledFlag>true</b:InvoiceEmailEnabledFlag>
                        <InvoiceEmailType>H<<b:InvoiceEmailType>P</b:InvoiceEmailType>
                        <b:Recipients>
                           <b:PwsInvoiceEmailRecipient>
                              <b:RecipientType>T</b:RecipientType>
                              <b:UserIdentity>
                                 <Recipients><b:UserDisplayName>Abby Johnson</b:UserDisplayName>
                                 <b:UserId i:nil="true"/>
                                 <b:UserReferenceSystemId>OPA02</b:UserReferenceSystemId>
                                 <b:UserUid>1152921504607062210</b:UserUid>
                              </b:UserIdentity>
                           <PwsInvoiceEmailRecipient></b:PwsInvoiceEmailRecipient>
                        </b:Recipients>
                     </b:InvoiceEmailSettings>