Overview
This web service can be used to delete a web invoice. An invoice cand be deleted if it is not issued, has been approved, and user has permission to delete it.
Note that this service will delete web invoices only, and cannot be used to delete Management Portal invoices.
Request Format
- PwsDeleteInvoice
- serviceRequest: PwsDeleteInvoiceRq
- RequestId: Int32
- SessionTicket: String
- InvoiceIdentity: PwsInvoiceRef
- InvoiceTimestamp: String
- LocksToSteal: PwsEntityLockSummary
- ProjectorLockSetId: Int32
- serviceRequest: PwsDeleteInvoiceRq
Request Elements
Element | Data Type | Required? | Default | Description |
---|---|---|---|---|
Int32 | No | Click here for more information. | ||
String | Yes | Click here for more information. | ||
InvoiceIdentity | Yes | Identity of invoice to be deleted. | ||
InvoiceTimestamp | String | No | A projector lock set id is an identifier for a group of one or more locks held as a unit. | |
LocksToSteal | No | This is an optimistic locking timestamp for the invoice to be deleted. If specified, must match the current invoice timestamp. | ||
ProjectorLockSetId | Int32 | No | If stealing existing locks, specify lock holders from PwsFault response. |
Request Usage Example(s)
Response Format
- PwsDeleteInvoiceResponse
- PwsDeleteInvoiceResult: PwsDeleteInvoiceRs
- Messages: PwsMessage]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- InvoiceIdentity: PwsInvoiceRef
- StolenLocks: PwsEntityLockSummary
- PwsDeleteInvoiceResult: PwsDeleteInvoiceRs
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. | |
StolenLocks | The locks that were stolen to execute the deletion |
Response Usage Example(s)
PwsDeleteInvoice - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|