Overview
This web service can be used to retrieve an invoice. Note that this service will retrieve web invoices only, and cannot be used to create Management Portal invoices.
Request Format
- PwsGetInvoice
- serviceRequest: PwsGetInvoiceRq
- RequestId: Int32
- SessionTicket: String
- IncludeAdjustmentHistoryFlag: Boolean
- IncludeFullAdjustmentHistoryFlag: Boolean
- InvoiceIdentity: PwsInvoiceRef
- serviceRequest: PwsGetInvoiceRq
Request Elements
Element | Data Type | Required? | Default | Description |
---|---|---|---|---|
Int32 | No | Click here for more information. | ||
String | Yes | Click here for more information. | ||
IncludeAdjustmentHistoryFlag | Boolean | No | false | True to include adjustment history in invoice detail |
IncludeFullAdjustmentHistoryFlag | Boolean | No | false | If IncludeAdjustmentHistoryFlag is set, true to include full card breakdown with each adjustment history record. |
InvoiceIdentity | This structure represents the unique key fields associated with identifying an invoice . |
Request Usage Example(s)
Response Format
- PwsGetInvoiceResponse
- PwsGetInvoiceResult: PwsGetInvoiceRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- Invoice: PwsInvoiceElement
- PwsGetInvoiceResult: PwsGetInvoiceRs
Response Elements
Element | Data Type | Description |
---|---|---|
Messages | The web service response status and message. Click here for more information | |
Int32 | Click here for more information | |
RequestStatus | Click here for more information | |
DateTime | Click here for more information. | |
Invoice | The set of basic information about an invoice |
Response Usage Example(s)
PwsGetInvoice - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|