Overview

Issuing an invoice or credit memo will transmit the invoice or credit memo to the accounts receivable system and will prevent the addition of further adjustments unless the invoice or credit memo is voided.

On issue the following things occur:

Assign an invoice number
Render the invoice
Prevent financial changes from being made to the invoice. See Preview / Re-Render Invoice to learn exactly what's locked down.
Queue an accounts receivable transaction for transmission to the accounting system
Optionally email the invoice to the client
Optionally download the invoice to your computer
Optionally upload the invoice to Projector Web

Request Format

PwsIssueInvoice Request

PwsIssueInvoice
- serviceRequest: PwsIssueInvoice
  - RequestId: Int32
  - SessionTicket: String
  - AddCommentsToInvoiceMessagesFlag: Boolean
  - FullDetailFlag: Boolean
  - IncludeAdjustmentHistoryFlag: Boolean
  - IncludeFullAdjustmentHistoryFlag: Boolean
  - InvoiceDate: DateTime
  - InvoiceIdentity: PwsInvoiceRef
  - InvoiceTimestamp: String
  - IssuedInvoiceNumber: String
  - LocksToSteal: PwsEntityLockSummary
  - NewInvoiceMessages: String
  - NotifyFinanceTeamFlag: Boolean
  - NotifyManagementTeamFlag: Boolean
  - NotifyPmTeamFlag: Boolean
  - PostFlag: Boolean
  - ProjectorLockSetId: Int32
  - SendFlag: Boolean
  - SkipIfIneligibleFlag: Boolean

Request Elements

Element	Data Type	Required?	Default	Description
RequestId	Int32	No		Click here for more information.
SessionTicket	String	Yes		Click here for more information.
AddCommentsToInvoiceMessagesFlag	Boolean	No	false	If set to 'true', the comments associated with the ivnoice will be added to the invoice message.
FullDetailFlag	Boolean	No	false	If set to 'true', include full detailed invoice element in response.
IncludeAdjustmentHistoryFlag	Boolean	No	false	If set to 'true', include adjustment history in response.
IncludeFullAdjustmentHistoryFlag	Boolean	No	false	If set to 'true', include full adjustment history in response.
InvoiceDate	DateTime	No	The date the invoice is issued	Defaults to the date the invoice is actually issued. This can be overridden here or at the time of issue. This date: determines the accounting period for the AR transaction start date for payment terms such as net 30
InvoiceIdentity	PwsInvoiceRef	Yes		This structure represents the unique key fields associated with identifying an invoice.
InvoiceTimestamp	String	No		This is a Base64 encoded timestamp optionally utilized for invoice locking.
IssuedInvoiceNumber	String	No		The invoice number is a unique identifier for an issued invoice.
LocksToSteal	PwsEntityLockSummary	No		If stealing existing locks, specify lock holders from PwsFault response.
NewInvoiceMessages	String	No
NotifyFinanceTeamFlag	Boolean
NotifyManagementTeamFlag	Boolean
NotifyPmTeamFlag	Boolean
PostFlag	Boolean
ProjectorLockSetId	Int32
SendFlag	Boolean
SkipIfIneligibleFlag	Boolean

Element	Data Type	Required?	Description	Sample Data
RequestId	Int32	No	Click here for more information.
SessionTicket	String	Yes	Click here for more information.	AftyRXSTlnMPzozuKwq0kQ=
DocumentIdentity	PwsDocumentRef	Yes	The identity of the document that is to be undeleted. Click here for more information.
MakeNameUniqueFlag	Boolean	No	If the undeleted document shares the same name as an existing document and this flag is set to 'true', then a number will appended to the undeleted document's name to make it unique.	true

Request Usage Example(s)

Example 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:doc="http://projectorpsa.com/DataContracts/Shared/DocumentManagement/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsUndeleteDocument>
         <pws:serviceRequest>
            <req:SessionTicket>AftyRXSTlnMPzozuKwq0kQ==</req:SessionTicket>
            <doc:DocumentIdentity>
               <com:DocumentRefUid>1152921504607635451</com:DocumentRefUid>
            </doc:DocumentIdentity>
         </pws:serviceRequest>
      </pws:PwsUndeleteDocument>
   </soapenv:Body>
</soapenv:Envelope>

Example 02 - unique name

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:doc="http://projectorpsa.com/DataContracts/Shared/DocumentManagement/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsUndeleteDocument>
         <pws:serviceRequest>
            <req:SessionTicket>ARaqO1NTOppS159NGsaYoA==</req:SessionTicket>
            <doc:DocumentIdentity>
               <com:DocumentRefUid>1152921504607775872</com:DocumentRefUid>
            </doc:DocumentIdentity>
             <doc:MakeNameUniqueFlag>true</doc:MakeNameUniqueFlag>
         </pws:serviceRequest>
      </pws:PwsUndeleteDocument>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsUndeleteDocument Response

PwsUndeleteDocumentResponse
- PwsUndeleteDocumentResult: PwsUndeleteDocumentRs
  - Messages: PwsMessage []
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - NewDocumentName: String

Response Elements

Element	Data Type	Description	Sample Data
Messages	PwsMessage []	The web service response status and message. Click here for more information.
ResponseId	Int32	Click here for more information.	0
Status	RequestStatus	Click here for more information.	Ok
ServerTimestampUtc	DateTime	Click here for more information.	2018-03-20T18:40:05.6295028Z
NewDocumentName	String	The new unique name of the undeleted document when request specifies MakeNameUniqueFlag as true.

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsUndeleteDocumentResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsUndeleteDocumentResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/DocumentManagement/" 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/">2018-03-20T18:40:05.6295028Z</ServerTimestampUtc>
         </PwsUndeleteDocumentResult>
      </PwsUndeleteDocumentResponse>
   </s:Body>
</s:Envelope>

Example 02 - unique name

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsUndeleteDocumentResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsUndeleteDocumentResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/DocumentManagement/" 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/">2018-12-18T18:58:29.8232667Z</ServerTimestampUtc>
            <a:NewDocumentName>Test (2).txt</a:NewDocumentName>
         </PwsUndeleteDocumentResult>
      </PwsUndeleteDocumentResponse>
   </s:Body>
</s:Envelope>

PwsUndeleteDocumentResponse - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
21012	DocumentRequiredForUndeleteDocument	A document identity must be specified.
75078	DocumentNameAlreadyInUse	This folder already contains a document with the same name. Operation cannot be completed.
75199	DocumentNotFound	Document not found.