Versions Compared

Key

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

Overview


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

For draft invoices, the draft invoice number is matched against the specified invoice number. For issued invoices, the invoice number (issued invoice number is used). A PwsInvoiceRef that refers to a draft invoice number will not match to an issued invoice, event if the specified invoice number matches the draft invoice number associated with the specified invoice.

Format


Panel
titlePwsInvoiceRef
  • PwsInvoiceRef
    • InvoiceId: Int32
    • InvoiceNumber: String (20)
    • InvoiceUid: Int64

Elements

...

Element

Data Type

Required?Default

Description

Sample Data

InvoiceId

Int32

No

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


InvoiceNumber

String  The Invoice Number (20)

One of InvoiceNumber or InvoiceUid is required


The invoice number is a unique identifier for an Invoice.

DRAFT00927

InvoiceUid

Int64 A

See InvoiceNumber

A unique and immutable Id identifier for an Invoiceinvoice.

1152921504607622580

Usage Example(s)

...

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