...
This 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 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 Invoice or the Invoice reference will not be considered valid. When a PwsInvoiceRef is returned in the response to a web service, both the InvoiceNumber and InvoiceUid will be populated, and guaranteed to refer to a single invoice.
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 | ||
|---|---|---|
| ||
|
...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
InvoiceId | Int32 | On Insert: No On Update: No | The invoice Id is a unique identifier for an invoice. For internal use only. | ||
InvoiceNumber | String (20)On Insert: | Yes (if One of InvoiceNumber or InvoiceUid is not supplied) On Update: Yes (if InvoiceUid is not supplied) required | The invoice number is a unique identifier for an Invoice. | DRAFT00927 | |
InvoiceUid | Int64 | On Insert: Yes (if InvoiceNumber is not supplied) On Update: Yes (if InvoiceNumber is not supplied) | The invoice Uid is a See InvoiceNumber | A unique and immutable identifier for an invoice. | 1152921504607622580 |
Usage Example(s)
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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> |