Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This web service can be used to create a web invoice. You specify the attributes to use for invoice creation by providing a InvoiceSpec, an instance of PwsCandidateInvoiceSpec. This structure allows you to specify the name, scope and content of the invoice, the approval statuses and other invoice attributes. See below for full details. The caller can optionally request that the full invoice detail PwsInvoiceElement be included in the response.  Note that this service will create web invoices only, and cannot be used to create Management Portal invoices.

...

Panel
titlePwsCreateInvoice Request
  • PwsCreateInvoice
    • serviceRequest: PwsCreateInvoiceRq
      • RequestId: Int32
      • SessionTicket: String
      • AddCommentsToInvoiceMessagesFlag: Boolean
      • ExcludeZeroAmountCostCardsFlag: Boolean
      • ExcludeZeroAmountTimeCardsFlag: Boolean
      • FullDetailFlag: Boolean
      • IncludeAdjustmentHistoryFlag: Boolean
      • IncludeFullAdjustmentHistoryFlag: Boolean
      • InvoiceSpec: 
      • NewInvoiceMessages: String
      • NotifyFinanceTeamFlag: Boolean
      • NotifyManagementTeamFlag: Boolean
      • NotifyPmTeamFlag: Boolean

Request Elements


Element

Data TypeRequired?DefaultDescription
RequestIdInt32No

Click here for more information


SessionTicketStringYes

Click here for more information


AddCommentsToInvoiceMessagesFlagBooleanNoFalseTrue to prepend comments (NewInvoiceMessages) to invoice message
ExcludeZeroAmountCostCardsFlagBooleanNoFalseTrue to exclude time cards with no value from invoice
ExcludeZeroAmountTimeCardsFlagBooleanNoFalseTrue to exclude cost cards with no value from invoice
FullDetailFlagBooleanNoFalseTrue to include the full details of the invoice in the response
IncludeAdjustmentHistoryFlagBooleanNoFalseIf FullDetailsFlag is set, true to include adjustment history in invoice detail
IncludeFullAdjustmentHistoryFlagBooleanNoFalseIf FullDetailsFlag is set and IncludeAdjustmentHistoryFlag is set, true to include full card breakdown with each
InvoiceSpecPwsCandidateInvoiceSpecYes
Attributes of the new invoice to be created
NewInvoiceMessagesString (1000)No
Invoice message to include workflow email. May also be added to invoice messages for the new invoice
NotifyFinanceTeamFlagBooleanNoFalseTrue to send an e-mail to the finance team response for finance approval of invoice upon creation
NotifyManagementTeamFlagBooleanNoFalseTrue to send an e-mail to the management team response for management approval of invoice upon creation
NotifyPmTeamFlagBooleanNoFalseTrue to send an e-mail to the PM team response for project manager approval of invoice upon creation

Request Usage Example(s)


Code Block
languagexml
titlePwsCreateInvoice
collapsetrue
<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:PwsCreateInvoice>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AcDDhcCta4Wna3CCTQ5Fng==</req:SessionTicket>
            <bil:AddCommentsToInvoiceMessagesFlag>true</bil:AddCommentsToInvoiceMessagesFlag>
            <bil:ExcludeZeroAmountCostCardsFlag>false</bil:ExcludeZeroAmountCostCardsFlag>
            <bil:ExcludeZeroAmountTimeCardsFlag>false</bil:ExcludeZeroAmountTimeCardsFlag>
            <bil:FullDetailFlag>true</bil:FullDetailFlag>
            <bil:IncludeAdjustmentHistoryFlag>true</bil:IncludeAdjustmentHistoryFlag>
            <bil:IncludeFullAdjustmentHistoryFlag>true</bil:IncludeFullAdjustmentHistoryFlag>
            <bil:InvoiceSpec>
               <bil:ApprovedByFinanceFlag>false</bil:ApprovedByFinanceFlag>
               <bil:ApprovedByManagementFlag>false</bil:ApprovedByManagementFlag>
               <bil:ApprovedByProjectManagerFlag>false</bil:ApprovedByProjectManagerFlag>
               <bil:BillingCultureIdentity>
                  <com:CultureName>en-US</com:CultureName>
               </bil:BillingCultureIdentity>
               <bil:CardBeginDate>2022-07-01T00:00:00.000Z</bil:CardBeginDate>
               <bil:CardEndDate>2022-07-05T00:00:00.000Z</bil:CardEndDate>
               <bil:ClientIdentity>
                  <com:ClientNumber>Amazon</com:ClientNumber>
               </bil:ClientIdentity>
               <bil:CostCenterIdentity>
                  <com:CostCenterName>Executive Team (USA)</com:CostCenterName>
               </bil:CostCenterIdentity>
               <bil:EngagementCurrencyIdentity>
                  <com:CurrencyCode>USD</com:CurrencyCode>
               </bil:EngagementCurrencyIdentity>
               <bil:EngagementIdentity>
                  <com:EngagementCode>P001666</com:EngagementCode>
               </bil:EngagementIdentity>
               <bil:EngagementInvoiceContent>B</bil:EngagementInvoiceContent>
               <bil:InvoiceContent>B</bil:InvoiceContent>
               <bil:InvoiceName>Invoice - WS</bil:InvoiceName>
               <bil:InvoiceScope>P</bil:InvoiceScope>
               <bil:ProjectIdentity>
                  <com:ProjectCode>P001666-001</com:ProjectCode>
               </bil:ProjectIdentity>
               <bil:PurchaseOrderNumber>Invoice - WS</bil:PurchaseOrderNumber>
            </bil:InvoiceSpec>
            <bil:NewInvoiceMessages>Invoice - WS</bil:NewInvoiceMessages>
            <bil:NotifyFinanceTeamFlag>true</bil:NotifyFinanceTeamFlag>
            <bil:NotifyManagementTeamFlag>true</bil:NotifyManagementTeamFlag>
            <bil:NotifyPmTeamFlag>true</bil:NotifyPmTeamFlag>
         </pws:serviceRequest>
      </pws:PwsCreateInvoice>
   </soapenv:Body>
</soapenv:Envelope>

...