PwsInvoiceTemplateRef

Overview


This structure represents the unique key fields associated with identifying an invoice template. Invoice Templates can be identified by InvoiceTemplateName or InvoiceTemplateUid. When specifying a PwsInvoiceTemplateRef as an input to a web service, you may specify one or both the InvoiceTemplateName and/or InvoiceTemplateUid. However, if you do specify both, they must both refer to the same invoice template or the invoice template reference will not be considered valid. When a PwsInvoiceTemplateRef is returned in the response to a web service, both the InvoiceTemplateName and InvoiceTemplateUid will be populated, and guaranteed to refer to a single invoice template.

Format


PwsInvoiceTemplateRef
  • PwsInvoiceTemplateRef
    • InvoiceTemplateId: Int32
    • InvoiceTemplateName: String (10)
    • InvoiceTemplateUid: Int64

Elements


Element

Data Type

Required?

Description

Sample Data

InvoiceTemplateId

Int32

No

The invoice template ID. For internal use only.


InvoiceTemplateName

String (10)

One of InvoiceTemplateName or InvoiceTemplateUid is required


The invoice template name is a unique identifier for an invoice template.

E001

InvoiceTemplateUid

Int64

See InvoiceTemplateName

A unique and immutable identifier for an invoice template.

1152921504606878906


Usage Example(s)


Example 01
                        <b:EmailInvoiceTemplateIdentity>
                           <b:InvoiceTemplateId i:nil="true"/>
                           <b:InvoiceTemplateName>E001</b:InvoiceTemplateName>
                           <b:InvoiceTemplateUid>1152921504606878906</b:InvoiceTemplateUid>
                        </b:EmailInvoiceTemplateIdentity>