Overview

This web service can be used to delete a web invoice. An invoice can be deleted if it is not issued. Note that this service will delete web invoices only, and cannot be used to delete Management Portal invoices.

Rate Limiting

In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm. When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate. Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly. For more information please visit: Projector Rate Limiting Behavior.

Request Format

PwsDeleteInvoice Request

PwsDeleteInvoiceRq
- RequestId: Int32
- SessionTicket: String
- InvoiceIdentity: PwsInvoiceRef
- InvoiceTimestamp: String
- LocksToSteal: PwsEntityLockSummary
- ProjectorLockSetId: Int32

Request Elements

Element	Data Type	Required?	Description
RequestId	Int32	No	Click here for more information.
SessionTicket	String	Yes	Click here for more information.
InvoiceIdentity	PwsInvoiceRef	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	PwsEntityLockSummary	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)

Request 01

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:bil="http://projectorpsa.com/DataContracts/Shared/Billing/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsDeleteInvoice>
         <!--Optional:-->
         <pws:serviceRequest>
            <req:SessionTicket>AcQ1BEusAT8qGh8BhF0OFg==</req:SessionTicket>
            <bil:InvoiceIdentity>
               <com:InvoiceNumber>DRAFT00158</com:InvoiceNumber>
            </bil:InvoiceIdentity>
         </pws:serviceRequest>
      </pws:PwsDeleteInvoice>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsDeleteInvoice Response

PwsDeleteInvoiceRs
- Messages: PwsMessage]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- InvoiceIdentity: PwsInvoiceRef
- StolenLocks: PwsEntityLockSummary

Response Elements

Element	Data Type	Description
Messages	PwsMessage[]	The web service response status and message. Click here for more information
ResponseId	Int32	Click here for more information
Status	RequestStatus	Click here for more information
ServerTimestampUtc	DateTime	Click here for more information.
InvoiceIdentity	PwsInvoiceRef	The identity of the deleted invoice.
StolenLocks	PwsEntityLockSummary	The locks that were stolen to execute the deletion

Response Usage Example(s)

Response 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsDeleteInvoiceResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsDeleteInvoiceResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/Billing/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2022-07-13T15:47:46.7404278Z</ServerTimestampUtc>
            <a:InvoiceIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:InvoiceId i:nil="true"/>
               <b:InvoiceNumber>DRAFT00157</b:InvoiceNumber>
               <b:InvoiceUid>1152921504607847590</b:InvoiceUid>
            </a:InvoiceIdentity>
            <a:StolenLocks i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
         </PwsDeleteInvoiceResult>
      </PwsDeleteInvoiceResponse>
   </s:Body>
</s:Envelope>

PwsDeleteInvoice - Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorNumber	ErrorCode	ErrorText
50024	EntityNotFound	Invoice was not found. Another user may have deleted it.
68216	CannotDeleteIssuedInvoice	You cannot delete invoice ... because it has been issued.

API Documentation

PwsDeleteInvoice

Analytics