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 Request

PwsGetInvoice
- serviceRequest: PwsGetInvoiceRq
  - RequestId: Int32
  - SessionTicket: String
  - IncludeAdjustmentHistoryFlag: Boolean
  - IncludeFullAdjustmentHistoryFlag: Boolean
  - InvoiceIdentity: PwsInvoiceRef

Request Elements

Element	Data Type	Required?	Default	Description	Sample Data
RequestId	Int32	No		Click here for more information.
SessionTicket	String	Yes		Click here for more information.	AcQ1BEusAT8qGh8BhF0OFg==
IncludeAdjustmentHistoryFlag	Boolean	No	false	True to include adjustment history in invoice detail	0
IncludeFullAdjustmentHistoryFlag	Boolean	No	false	If IncludeAdjustmentHistoryFlag is set, true to include full card breakdown with each adjustment history record.	0
InvoiceIdentity	PwsInvoiceRef			This structure represents the unique key fields associated with identifying an invoice .

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:PwsGetInvoice>
         <!--Optional:-->
         <pws:serviceRequest>
            <req:SessionTicket>AcQ1BEusAT8qGh8BhF0OFg==</req:SessionTicket>
            <!--Optional:-->
            <bil:IncludeAdjustmentHistoryFlag>1</bil:IncludeAdjustmentHistoryFlag>
            <!--Optional:-->
            <bil:IncludeFullAdjustmentHistoryFlag>0</bil:IncludeFullAdjustmentHistoryFlag>
            <bil:InvoiceIdentity>
               <com:InvoiceNumber>DRAFT00155</com:InvoiceNumber>
            </bil:InvoiceIdentity>
         </pws:serviceRequest>
      </pws:PwsGetInvoice>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetInvoice Response

PwsGetInvoiceResponse
- PwsGetInvoiceResult: PwsGetInvoiceRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - Invoice: PwsInvoiceElement

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.
Invoice	PwsInvoiceElement	The set of basic information about an invoice

Response Usage Example(s)

Response 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetInvoiceResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetInvoiceResult 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-13T14:27:15.9751207Z</ServerTimestampUtc>
            <a:Invoice xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:AdjustmentHistory>
                  <b:PwsInvoiceAdjustmentHistory>
                     <b:AdjustedCostCards/>
                     <b:AdjustedTimeCards/>
                     <b:AdjustmentCodeIdentity i:nil="true"/>
                     <b:AdjustmentHistoryId i:nil="true"/>
                     <b:AdjustmentHistoryUid>1152921504610130051</b:AdjustmentHistoryUid>
                     <b:AdjustmentSubtype i:nil="true"/>
                     <b:AdjustmentType>IT</b:AdjustmentType>
                     <b:AfterAdjustmentCardValue>204.31</b:AfterAdjustmentCardValue>
                     <b:BeforeAdjustmentCardValue>204.31</b:BeforeAdjustmentCardValue>
                     <b:CardCount>2</b:CardCount>
                     <b:EnteredByUser>
                        <b:UserDisplayName>PPSA Support User</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>000</b:UserReferenceSystemId>
                        <b:UserUid>1152921504606944261</b:UserUid>
                        <b:EmailAddress>support@projectorpsa.com</b:EmailAddress>
                        <b:FirstName>PPSA Support User</b:FirstName>
                        <b:LastName>PPSA Support User</b:LastName>
                        <b:MiddleName>PPSA Support User</b:MiddleName>
                     </b:EnteredByUser>
                     <b:Explanation i:nil="true"/>
                     <b:TransactionTimestamp>2022-03-21T19:42:48.283Z</b:TransactionTimestamp>
                     <b:UdfDefinitionIdentity i:nil="true"/>
                  </b:PwsInvoiceAdjustmentHistory>
               </b:AdjustmentHistory>
               <b:AllowAccountingPeriodOverrideFlag>false</b:AllowAccountingPeriodOverrideFlag>
               <b:ApprovedByFinanceFlag>false</b:ApprovedByFinanceFlag>
               <b:ApprovedByFinanceTimestamp i:nil="true"/>
               <b:ApprovedByFinanceUser i:nil="true"/>
               <b:ApprovedByManagementFlag>false</b:ApprovedByManagementFlag>
               <b:ApprovedByManagementTimestamp i:nil="true"/>
               <b:ApprovedByManagementUser i:nil="true"/>
               <b:ApprovedByProjectManagerFlag>false</b:ApprovedByProjectManagerFlag>
               <b:ApprovedByProjectManagerTimestamp i:nil="true"/>
               <b:ApprovedByProjectManagerUser i:nil="true"/>
               <b:AutoManagementApprovalFlag>true</b:AutoManagementApprovalFlag>
               <b:AvailableBalances>
                  <b:PwsInvoiceAvailableBalance>
                     <b:ContractLineItem>
                        <b:ContractLineItemCode>LATR-CL1</b:ContractLineItemCode>
                        <b:ContractLineItemId i:nil="true"/>
                        <b:ContractLineItemUid>1152921504606894939</b:ContractLineItemUid>
                        <b:ContractLineItemName>La Traviata</b:ContractLineItemName>
                        <b:EngagementIdentity>
                           <b:EngagementCode>LATR</b:EngagementCode>
                           <b:EngagementId i:nil="true"/>
                           <b:EngagementUid>1152921504607124866</b:EngagementUid>
                        </b:EngagementIdentity>
                     </b:ContractLineItem>
                     <b:EditableFlag>true</b:EditableFlag>
                     <b:UnappliedPrepaidAmount>0</b:UnappliedPrepaidAmount>
                  </b:PwsInvoiceAvailableBalance>
                  <b:PwsInvoiceAvailableBalance>
                     <b:ContractLineItem>
                        <b:ContractLineItemCode>P001062-CL1</b:ContractLineItemCode>
                        <b:ContractLineItemId i:nil="true"/>
                        <b:ContractLineItemUid>1152921504606895264</b:ContractLineItemUid>
                        <b:ContractLineItemName>Copy of La Traviata</b:ContractLineItemName>
                        <b:EngagementIdentity>
                           <b:EngagementCode>P001062</b:EngagementCode>
                           <b:EngagementId i:nil="true"/>
                           <b:EngagementUid>1152921504607125286</b:EngagementUid>
                        </b:EngagementIdentity>
                     </b:ContractLineItem>
                     <b:EditableFlag>true</b:EditableFlag>
                     <b:UnappliedPrepaidAmount>0</b:UnappliedPrepaidAmount>
                  </b:PwsInvoiceAvailableBalance>
                  <b:PwsInvoiceAvailableBalance>
                     <b:ContractLineItem>
                        <b:ContractLineItemCode>P001075-CL1</b:ContractLineItemCode>
                        <b:ContractLineItemId i:nil="true"/>
                        <b:ContractLineItemUid>1152921504606900755</b:ContractLineItemUid>
                        <b:ContractLineItemName>Rigoletto</b:ContractLineItemName>
                        <b:EngagementIdentity>
                           <b:EngagementCode>P001075</b:EngagementCode>
                           <b:EngagementId i:nil="true"/>
                           <b:EngagementUid>1152921504607141590</b:EngagementUid>
                        </b:EngagementIdentity>
                     </b:ContractLineItem>
                     <b:EditableFlag>true</b:EditableFlag>
                     <b:UnappliedPrepaidAmount>0</b:UnappliedPrepaidAmount>
                  </b:PwsInvoiceAvailableBalance>
               </b:AvailableBalances>
               <b:AvailableMilestones/>
               <b:CardBeginDate i:nil="true"/>
               <b:CardEndDate i:nil="true"/>
               <b:Client>
                  <b:ClientId i:nil="true"/>
                  <b:ClientNumber>C000111</b:ClientNumber>
                  <b:ClientUid>1152921504606906284</b:ClientUid>
                  <b:ClientName>Metro Opera</b:ClientName>
                  <b:InactiveFlag>false</b:InactiveFlag>
                  <b:ParentClientIdentity i:nil="true"/>
               </b:Client>
               <b:CompanyIdentity>
                  <b:CompanyId i:nil="true"/>
                  <b:CompanyName>Revolutionary Solutions Corporation  US</b:CompanyName>
                  <b:CompanyUid>1152921504606849272</b:CompanyUid>
                  <b:CompanyNumber>001</b:CompanyNumber>
               </b:CompanyIdentity>
               <b:CostCardAdjustmentAmount>0</b:CostCardAdjustmentAmount>
               <b:CostCardExclusionsAmount>0</b:CostCardExclusionsAmount>
               <b:CostCardInvoicedAmount>0</b:CostCardInvoicedAmount>
               <b:CostCardRequireLocationFlag>false</b:CostCardRequireLocationFlag>
               <b:CostCenterIdentity>
                  <b:CostCenterId i:nil="true"/>
                  <b:CostCenterName>US-Public Sector*</b:CostCenterName>
                  <b:CostCenterNumber>US1</b:CostCenterNumber>
                  <b:CostCenterUid>1152921504606856645</b:CostCenterUid>
               </b:CostCenterIdentity>
               <b:CreatedByUser>
                  <b:UserDisplayName>PPSA Support User</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>000</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606944261</b:UserUid>
                  <b:EmailAddress>support@projectorpsa.com</b:EmailAddress>
                  <b:FirstName>PPSA Support User</b:FirstName>
                  <b:LastName>PPSA Support User</b:LastName>
                  <b:MiddleName>PPSA Support User</b:MiddleName>
               </b:CreatedByUser>
               <b:CreatedTimestamp>2022-03-21T19:42:48.243Z</b:CreatedTimestamp>
               <b:DeletedFlag>false</b:DeletedFlag>
               <b:DraftCostCardCount>2</b:DraftCostCardCount>
               <b:DraftInvoiceNumber>DRAFT00155</b:DraftInvoiceNumber>
               <b:DraftTimeCardCount>0</b:DraftTimeCardCount>
               <b:Engagement i:nil="true"/>
               <b:ExcludeZeroAmountCostCardsFlag>false</b:ExcludeZeroAmountCostCardsFlag>
               <b:ExcludeZeroAmountTimeCardsFlag>false</b:ExcludeZeroAmountTimeCardsFlag>
               <b:ExcludedCostCardAmount>0</b:ExcludedCostCardAmount>
               <b:ExcludedCostCardCount>0</b:ExcludedCostCardCount>
               <b:ExcludedMilestoneAmount>0</b:ExcludedMilestoneAmount>
               <b:ExcludedMilestoneCount>0</b:ExcludedMilestoneCount>
               <b:ExcludedTimeCardAmount>0</b:ExcludedTimeCardAmount>
               <b:ExcludedTimeCardCount>0</b:ExcludedTimeCardCount>
               <b:GrossInvoiceAmount>204.31</b:GrossInvoiceAmount>
               <b:IncludedCostCardCount>0</b:IncludedCostCardCount>
               <b:IncludedMilestoneCount>0</b:IncludedMilestoneCount>
               <b:IncludedMilestones/>
               <b:IncludedTimeCardCount>2</b:IncludedTimeCardCount>
               <b:InvoiceContent>A</b:InvoiceContent>
               <b:InvoiceCurrencyDecimalDigits>2</b:InvoiceCurrencyDecimalDigits>
               <b:InvoiceCurrencyIdentity>
                  <b:CurrencyCode>USD</b:CurrencyCode>
                  <b:CurrencyId i:nil="true"/>
                  <b:CurrencyUid>1152921504606849879</b:CurrencyUid>
               </b:InvoiceCurrencyIdentity>
               <b:InvoiceDetail>
                  <b:InvoiceId i:nil="true"/>
                  <b:InvoiceNumber>DRAFT00155</b:InvoiceNumber>
                  <b:InvoiceUid>1152921504607817583</b:InvoiceUid>
                  <b:InvoiceDate i:nil="true"/>
                  <b:InvoiceName>Metro Opera</b:InvoiceName>
                  <b:BillingAddress>
                     <b:AddressLine1>1 Lincoln Center</b:AddressLine1>
                     <b:AddressLine2>performance art center</b:AddressLine2>
                     <b:Attention>Peter Gelb</b:Attention>
                     <b:City>New York</b:City>
                     <b:CompanyName>Metro Opera</b:CompanyName>
                     <b:Country>USA</b:Country>
                     <b:StateOrProvince>NY</b:StateOrProvince>
                     <b:ZipOrPostalCode>34567</b:ZipOrPostalCode>
                  </b:BillingAddress>
                  <b:BillingCultureIdentity>
                     <b:CultureId i:nil="true"/>
                     <b:CultureName>en-US</b:CultureName>
                     <b:CultureUid>1152921504606848626</b:CultureUid>
                  </b:BillingCultureIdentity>
                  <b:BillingInstructions i:nil="true"/>
                  <b:ClientMessage i:nil="true"/>
                  <b:ClientMessagePlain i:nil="true"/>
                  <b:ContractLineItems>
                     <b:PwsInvoiceContractLineItem>
                        <b:AppliedPrepaidAmount>0</b:AppliedPrepaidAmount>
                        <b:ContractLineItemIdentity>
                           <b:ContractLineItemCode>LATR-CL1</b:ContractLineItemCode>
                           <b:ContractLineItemId i:nil="true"/>
                           <b:ContractLineItemUid>1152921504606894939</b:ContractLineItemUid>
                        </b:ContractLineItemIdentity>
                     </b:PwsInvoiceContractLineItem>
                  </b:ContractLineItems>
                  <b:CostGrossAmtOption>C</b:CostGrossAmtOption>
                  <b:DistributionSettings>
                     <b:EmailSettings>
                        <b:EmailFromUserIdentity i:nil="true"/>
                        <b:EmailInvoiceTemplateIdentity i:nil="true"/>
                        <b:InvoiceEmailEnabledFlag>false</b:InvoiceEmailEnabledFlag>
                        <b:InvoiceEmailType i:nil="true"/>
                        <b:Recipients/>
                     </b:EmailSettings>
                     <b:SubjectText>Metro Opera</b:SubjectText>
                  </b:DistributionSettings>
                  <b:InvoiceMessages i:nil="true"/>
                  <b:InvoiceTemplateIdentity>
                     <b:InvoiceTemplateId i:nil="true"/>
                     <b:InvoiceTemplateName>A100</b:InvoiceTemplateName>
                     <b:InvoiceTemplateUid>1152921504606877639</b:InvoiceTemplateUid>
                  </b:InvoiceTemplateIdentity>
                  <b:OverrideAccountingPeriodIdentity i:nil="true"/>
                  <b:PaymentTermIdentity>
                     <b:PaymentTermId i:nil="true"/>
                     <b:PaymentTermName>Net 30</b:PaymentTermName>
                     <b:PaymentTermUid>1152921504606853147</b:PaymentTermUid>
                  </b:PaymentTermIdentity>
                  <b:PurchaseOrderNumber i:nil="true"/>
                  <b:RenderReceiptsFlag>false</b:RenderReceiptsFlag>
                  <b:RenderedInvoiceFormat>P</b:RenderedInvoiceFormat>
                  <b:Taxes/>
                  <b:TimeBillingType>H</b:TimeBillingType>
                  <b:TimeGrossAmtOption>S</b:TimeGrossAmtOption>
                  <b:Timestamp>AAAAABygkok=</b:Timestamp>
               </b:InvoiceDetail>
               <b:InvoiceNumberHistory>DRAFT00155</b:InvoiceNumberHistory>
               <b:InvoiceRecipients/>
               <b:InvoiceScope>C</b:InvoiceScope>
               <b:InvoiceStatus>D</b:InvoiceStatus>
               <b:IssuedByUser i:nil="true"/>
               <b:IssuedTimestamp i:nil="true"/>
               <b:LastUpdatedByUser>
                  <b:UserDisplayName>PPSA Support User</b:UserDisplayName>
                  <b:UserId i:nil="true"/>
                  <b:UserReferenceSystemId>000</b:UserReferenceSystemId>
                  <b:UserUid>1152921504606944261</b:UserUid>
                  <b:EmailAddress>support@projectorpsa.com</b:EmailAddress>
                  <b:FirstName>PPSA Support User</b:FirstName>
                  <b:LastName>PPSA Support User</b:LastName>
                  <b:MiddleName>PPSA Support User</b:MiddleName>
               </b:LastUpdatedByUser>
               <b:LastUpdatedTimestamp>2022-03-21T19:42:48.243Z</b:LastUpdatedTimestamp>
               <b:ManagementApprovalThresholdAmount>100</b:ManagementApprovalThresholdAmount>
               <b:ManagementApprovalThresholdPercent>0.1</b:ManagementApprovalThresholdPercent>
               <b:MilestoneInvoicedAmount>0</b:MilestoneInvoicedAmount>
               <b:NetInvoiceAmount>204.31</b:NetInvoiceAmount>
               <b:PaidByUser i:nil="true"/>
               <b:PaidTimestamp i:nil="true"/>
               <b:PaymentComment i:nil="true"/>
               <b:PostFailedFlag>false</b:PostFailedFlag>
               <b:PostFailureStatusMessage i:nil="true"/>
               <b:PostStatus>U</b:PostStatus>
               <b:PostedByUser i:nil="true"/>
               <b:PostedFlag>false</b:PostedFlag>
               <b:PostedTimestamp i:nil="true"/>
               <b:Project i:nil="true"/>
               <b:RejectedCostCardCount>0</b:RejectedCostCardCount>
               <b:RejectedTimeCardCount>0</b:RejectedTimeCardCount>
               <b:RevaluePlEffect>0</b:RevaluePlEffect>
               <b:SendFailedFlag>false</b:SendFailedFlag>
               <b:SendFailureStatusMessage i:nil="true"/>
               <b:SendStatus>U</b:SendStatus>
               <b:SentByUser i:nil="true"/>
               <b:SentFlag>false</b:SentFlag>
               <b:SentTimestamp i:nil="true"/>
               <b:TimeCardAdjustmentAmount>0</b:TimeCardAdjustmentAmount>
               <b:TimeCardExclusionsAmount>0</b:TimeCardExclusionsAmount>
               <b:TimeCardInvoicedAmount>204.31</b:TimeCardInvoicedAmount>
               <b:TimeCardRequireLocationFlag>true</b:TimeCardRequireLocationFlag>
               <b:UnapprovedCostCardCount>8</b:UnapprovedCostCardCount>
               <b:UnapprovedTimeCardCount>0</b:UnapprovedTimeCardCount>
               <b:VoidedByUser i:nil="true"/>
               <b:VoidedTimestamp i:nil="true"/>
               <b:WebInvoiceFlag>true</b:WebInvoiceFlag>
               <b:WriteUpWriteDownPlEffect>0</b:WriteUpWriteDownPlEffect>
            </a:Invoice>
         </PwsGetInvoiceResult>
      </PwsGetInvoiceResponse>
   </s:Body>
</s:Envelope>

PwsGetInvoice - 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.