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 | ||
---|---|---|
| ||
|
Elements
Element | Data Type | Required? |
---|
Description | Sample Data | |
---|---|---|
InvoiceId | Int32 |
No | The invoice Id is a unique identifier for an |
invoice. For internal use only. | |
InvoiceNumber | String |
(20) | One of InvoiceNumber or InvoiceUid is required | The invoice number is a unique identifier for an Invoice. | DRAFT00927 |
InvoiceUid | Int64 |
See InvoiceNumber | A unique and immutable |
identifier for an |
invoice. | 1152921504607622580 |
Usage Example(s)
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<b:InvoiceIdentity>
<b:InvoiceId i:nil="true"/>
<b:InvoiceNumber>DRAFT00927</b:InvoiceNumber>
<b:InvoiceUid>1152921504607622580</b:InvoiceUid>
</b:InvoiceIdentity>
|