PwsInvoiceDetail

Owned by Min Zeng
Last updated: May 07, 2024

Overview

This structure contains the complete set of information about an invoice. The structure is used both to retrieve detailed invoice information and to pass information about an invoice back to the server to get updated.

Format

PwsInvoiceDetail

Elements

Element

Data Type

Required?

Default

Description

InvoiceId

Int32

On Insert: No

On Update: One of InvoiceId, InvoiceNumber or InvoiceUid is required


The invoice id is a unique identifier for an invoice. For internal use only.

InvoiceNumber

String

On Insert: No

On Update: One of InvoiceId, InvoiceNumber or InvoiceUid is required


The invoice number is a unique identifier for an invoice

InvoiceUid

Int64

On Insert: No

On Update: One of InvoiceId, InvoiceNumber or InvoiceUid is required


A unique and immutable Id for an invoice

InvoiceDate

DateTime

No


The invoice date

InvoiceName

String

On Insert: Yes

On Update: No


The invoice name

BillingAddress

PwsAddress

No


The complete billing address on the invoice

BillingCultureIdentity

PwsCultureRef

On Insert: Yes

On Update: No


The invoice culture

BillingInstructions

String

No


Specific billing instructions for this client. The person that prepares the client's invoice will see these instructions, but the client will not.

ClientMessage

String

No


An optional message to be displayed on the client's invoice

ClientMessagePlain

String

No


An optional message (without formatting) to be displayed on the client's invoice

ContractLineItems

PwsInvoiceContractLineItem[]

Yes


This data structure reprensents one contract line item that is associated with the invoice

CostGrossAmtOption

String




DistributionSettings

PwsInvoiceDistributionSettings

No


This data structure includes the email setting on an invoice that can be distributed after being issued

InvoiceMessages

String

No


The invoice tab message for this specified project

InvoiceTemplateIdentity

PwsInvoiceTemplateRef

On Insert: Yes

On Update: No


The layout that will be used for this client's invoices

OverrideAccountingPeriodIdentity

PwsAccountingPeriodRef



Only available if Allow user to override accounting period on invoices is checked on the Billing tab in System Settings. Used to select the desired accounting period for associated AR transactions related to this invoice. Only accounting periods open for AR are available in this list.

PaymentTermIdentity

PwsPaymentTermRef

On Insert: Yes

On Update: No


Payment Terms define when payment of an invoice is due

PurchaseOrderNumber

String

No


The invoice purchase order number

RenderReceiptsFlag

Boolean

On Insert: Yes

On Update: No

false

If set to 'true' associated receipts will be rendered with this invoice

RenderedInvoiceFormat

String

On Insert: Yes

On Update: No


The format of the invoice when rendered

Taxes

PwsInvoiceTax[]

No


The taxes associated with this invoice

TimeBillingType

String

On Insert: Yes

On Update: No


The time billing type:

"D" for daily

"H" for hourly 

TimeGrossAmtOption

String




Timestamp

String

No


The date/time the invoice was created

UserDefinedFields

PwsUserDefinedFieldDetail [0...100]

On Insert: Dependent on UDF Definition

On Update: No


The client user defined field values associated with this client.

Usage Example(s)


Example 01 
                 <b:InvoiceDetail>
                  <b:InvoiceId i:nil="true"/>
                  <b:InvoiceNumber>DRAFT00162</b:InvoiceNumber>
                  <b:InvoiceUid>1152921504607847653</b:InvoiceUid>
                  <b:InvoiceDate>2022-07-13T00:00:00</b:InvoiceDate>
                  <b:InvoiceName>Van Gogh and Nature exhibit</b:InvoiceName>
                  <b:BillingAddress>
                     <b:AddressLine1 i:nil="true"/>
                     <b:AddressLine2 i:nil="true"/>
                     <b:Attention i:nil="true"/>
                     <b:City i:nil="true"/>
                     <b:CompanyName i:nil="true"/>
                     <b:Country i:nil="true"/>
                     <b:StateOrProvince i:nil="true"/>
                     <b:ZipOrPostalCode i:nil="true"/>
                  </b:BillingAddress>
                  <b:BillingCultureIdentity>
                     <b:CultureId i:nil="true"/>
                     <b:CultureName>en-US</b:CultureName>
                     <b:CultureUid>1152921504606848626</b:CultureUid>
                  </b:BillingCultureIdentity>
                  <b:BillingInstructions i:nil="true"/>
                  <b:ClientMessage i:nil="true"/>
                  <b:ClientMessagePlain i:nil="true"/>
                  <b:ContractLineItems>
                     <b:PwsInvoiceContractLineItem>
                        <b:AppliedPrepaidAmount>500</b:AppliedPrepaidAmount>
                        <b:ContractLineItemIdentity>
                           <b:ContractLineItemCode>VANGOGH-CL1</b:ContractLineItemCode>
                           <b:ContractLineItemId i:nil="true"/>
                           <b:ContractLineItemUid>1152921504606994259</b:ContractLineItemUid>
                        </b:ContractLineItemIdentity>
                     </b:PwsInvoiceContractLineItem>
                  </b:ContractLineItems>
                  <b:CostGrossAmtOption>C</b:CostGrossAmtOption>
                  <b:DistributionSettings>
                     <b:EmailSettings>
                        <b:EmailFromUserIdentity>
                           <b:UserDisplayName>Min Zeng</b:UserDisplayName>
                           <b:UserId i:nil="true"/>
                           <b:UserReferenceSystemId>ID-MZ</b:UserReferenceSystemId>
                           <b:UserUid>1152921504606944258</b:UserUid>
                        </b:EmailFromUserIdentity>
                        <b:EmailInvoiceTemplateIdentity>
                           <b:InvoiceTemplateId i:nil="true"/>
                           <b:InvoiceTemplateName>E003</b:InvoiceTemplateName>
                           <b:InvoiceTemplateUid>1152921504606878415</b:InvoiceTemplateUid>
                        </b:EmailInvoiceTemplateIdentity>
                        <b:InvoiceEmailEnabledFlag>true</b:InvoiceEmailEnabledFlag>
                        <b:InvoiceEmailType>H</b:InvoiceEmailType>
                        <b:Recipients>
                           <b:PwsInvoiceEmailRecipient>
                              <b:RecipientType>T</b:RecipientType>
                              <b:UserIdentity>
                                 <b:UserDisplayName>Clark, William</b:UserDisplayName>
                                 <b:UserId i:nil="true"/>
                                 <b:UserReferenceSystemId i:nil="true"/>
                                 <b:UserUid>1152921504607172137</b:UserUid>
                              </b:UserIdentity>
                           </b:PwsInvoiceEmailRecipient>
                        </b:Recipients>
                     </b:EmailSettings>
                     <b:SubjectText>Van Gogh and Nature exhibit</b:SubjectText>
                  </b:DistributionSettings>
                  <b:InvoiceMessages i:nil="true"/>
                  <b:InvoiceTemplateIdentity>
                     <b:InvoiceTemplateId i:nil="true"/>
                     <b:InvoiceTemplateName>A100</b:InvoiceTemplateName>
                     <b:InvoiceTemplateUid>1152921504606877639</b:InvoiceTemplateUid>
                  </b:InvoiceTemplateIdentity>
                  <b:OverrideAccountingPeriodIdentity i:nil="true"/>
                  <b:PaymentTermIdentity>
                     <b:PaymentTermId i:nil="true"/>
                     <b:PaymentTermName>Net 15</b:PaymentTermName>
                     <b:PaymentTermUid>1152921504606853146</b:PaymentTermUid>
                  </b:PaymentTermIdentity>
                  <b:PurchaseOrderNumber i:nil="true"/>
                  <b:RenderReceiptsFlag>false</b:RenderReceiptsFlag>
                  <b:RenderedInvoiceFormat>P</b:RenderedInvoiceFormat>
                  <b:Taxes>
                     <b:PwsInvoiceTax>
                        <b:TaxAmountOverrideFlag>false</b:TaxAmountOverrideFlag>
                        <b:TaxTypeIdentity>
                           <b:TaxTypeCode>GSTCA</b:TaxTypeCode>
                           <b:TaxTypeId i:nil="true"/>
                           <b:TaxTypeUid>1152921504606859965</b:TaxTypeUid>
                        </b:TaxTypeIdentity>
                        <b:TaxableAmount>2495.3</b:TaxableAmount>
                     </b:PwsInvoiceTax>
                  </b:Taxes>
                  <b:TimeBillingType>H</b:TimeBillingType>
                  <b:TimeGrossAmtOption>S</b:TimeGrossAmtOption>
                  <b:Timestamp>AAAAAB5C9LM=</b:Timestamp>
               </b:InvoiceDetail>