Versions Compared

Key

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

Overview


This specifies the identity of an Invoice. Invoices can be identified by InvoiceNumber or InvoiceUid. When specifying an PwsInvoiceRef as an input to a web service, you may specify one or both the InvoiceNumber and InvoiceUid. However, if you do specify both they must both refer to the same Client or the Client Reference will not be considered valid. When a PwsClientRef is returned in the response to a web service, both the ClientUid and ClientNumber will be populated, and guaranteed to refer to a single Client.

Format


Panel
titlePwsInvoiceRef
  • PwsInvoiceRef
    • InvoiceId: Int32
    • InvoiceNumber: String
    • InvoiceUid: Int64

Elements


Element

Data Type

Required?

Default

Description

Sample Data

InvoiceId

Int32



 The Invoice Id is a unique identifier for an Invoice. For internal use only.


InvoiceNumber

String



 The Invoice Number is a unique identifier for an Invoice.

DRAFT00927

InvoiceUid

Int64



 A unique and immutable Id for an Invoice.

1152921504607622580

Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
                        <InvoiceIdentity>
                           <InvoiceId i:nil="true"/>
                           <InvoiceNumber>DRAFT00927</InvoiceNumber>
                           <InvoiceUid>1152921504607622580</InvoiceUid>
                        </InvoiceIdentity>