Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 42 Current »

Overview


This specifies all the fields associated with Invoices that are to be e-mailed

Format


PwsInvoiceEmailSettings

Elements


Element

Data Type

Required?

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


EmailInvoiceTemplateIdentity

PwsInvoiceTemplateRef

On Insert: Yes

On Update: Yes

The invoice email template that will be used for this invoice


InvoiceEmailEnabledFlag

Boolean

On Insert: Yes

On Update: Yes

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

true

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 []

On Insert: Yes

On Update: Yes

The recipient(s) of the invoice email

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)


PwsInvoiceEmailSettings 
                     <b:InvoiceEmailSettings>
                        <b:EmailFromUserIdentity>
                           <b:UserDisplayName>Betty Smith</b:UserDisplayName>
                           <b:UserId i:nil="true"/>
                           <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                           <b:UserUid>1152921504607011056</b:UserUid>
                        </b:EmailFromUserIdentity>
                        <b:EmailInvoiceTemplateIdentity>
                           <b:InvoiceTemplateId i:nil="true"/>
                           <b:InvoiceTemplateName>E001</b:InvoiceTemplateName>
                           <b:InvoiceTemplateUid>1152921504606878906</b:InvoiceTemplateUid>
                        </b:EmailInvoiceTemplateIdentity>
                        <b:InvoiceEmailEnabledFlag>true</b:InvoiceEmailEnabledFlag>
                        <b:InvoiceEmailType>P</b:InvoiceEmailType>
                        <b:Recipients>
                           <b:PwsInvoiceEmailRecipient>
                              <b:RecipientType>T</b:RecipientType>
                              <b:UserIdentity>
                                 <b:UserDisplayName>Abby Johnson</b:UserDisplayName>
                                 <b:UserId i:nil="true"/>
                                 <b:UserReferenceSystemId>OPA02</b:UserReferenceSystemId>
                                 <b:UserUid>1152921504607062210</b:UserUid>
                              </b:UserIdentity>
                           </b:PwsInvoiceEmailRecipient>
                        </b:Recipients>
                     </b:InvoiceEmailSettings>
  • No labels