...
| Panel | ||
|---|---|---|
| ||
|
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 | True to prepend comments (NewInvoiceMessages) to invoice message | |
| ExcludeZeroAmountCostCardsFlag | Boolean | No | False | True to exclude time cards with no value from invoice | |
| ExcludeZeroAmountTimeCardsFlag | Boolean | No | False | True to exclude cost cards with no value from invoice | |
| FullDetailFlag | Boolean | No | False | True to include the full details of the invoice in the response | |
| IncludeAdjustmentHistoryFlag | Boolean | No | False | If FullDetailsFlag is set, true to include adjustment history in invoice detail | |
| IncludeFullAdjustmentHistoryFlag | Boolean | No | False | If FullDetailsFlag is set and IncludeAdjustmentHistoryFlag is set, true to include full card breakdown with each | |
| InvoiceSpec | PwsCandidateInvoiceSpec | Yes | Attributes of the new invoice to be created | ||
| NewInvoiceMessages | String (1000) | No | Invoice message to include workflow email. May also be added to invoice messages for the new invoice | ||
| NotifyFinanceTeamFlag | Boolean | No | False | True to send an e-mail to the finance team response for finance approval of invoice upon creation | |
| NotifyManagementTeamFlag | Boolean | No | False | True to send an e-mail to the management team response for management approval of invoice upon creation | |
| NotifyPmTeamFlag | Boolean | No | False | True to send an e-mail to the PM team response for project manager approval of invoice upon creation |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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> |
...
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
ResponseId | Int32 | Click here for more information | 1 |
Status | Click here for more information. | Ok | |
ServerTimestampUtc | DateTime | Click here for more information | 2018-01-29T21:55:08.7579802Z |
| Invoice | PwsInvoiceElement | The complete details if FullDetailFlag is specified on request | |
| InvoiceIdentity | PwsInvoiceRef | The identity of the newly created invoice | |
| InvoiceTimeStamp | String | This is an optimisitc locking timestamp for the newly created invoice |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsCreateInvoiceResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsCreateInvoiceResult 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/">1</ResponseId>
<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2022-07-12T15:26:20.1132902Z</ServerTimestampUtc>
<a:Invoice xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<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>P001666-CL1</b:ContractLineItemCode>
<b:ContractLineItemId i:nil="true"/>
<b:ContractLineItemUid>1152921504607167042</b:ContractLineItemUid>
<b:ContractLineItemName>R23 - 2022</b:ContractLineItemName>
<b:EngagementIdentity>
<b:EngagementCode>P001666</b:EngagementCode>
<b:EngagementId i:nil="true"/>
<b:EngagementUid>1152921504607393774</b:EngagementUid>
</b:EngagementIdentity>
</b:ContractLineItem>
<b:EditableFlag>true</b:EditableFlag>
<b:UnappliedPrepaidAmount>0</b:UnappliedPrepaidAmount>
</b:PwsInvoiceAvailableBalance>
</b:AvailableBalances>
<b:AvailableMilestones/>
<b:CardBeginDate>2022-07-01T00:00:00</b:CardBeginDate>
<b:CardEndDate>2022-07-05T00:00:00</b:CardEndDate>
<b:Client>
<b:ClientId i:nil="true"/>
<b:ClientNumber>AMAZON</b:ClientNumber>
<b:ClientUid>1152921504606971723</b:ClientUid>
<b:ClientName>Amazon</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:Client>
<b:CompanyIdentity>
<b:CompanyId i:nil="true"/>
<b:CompanyName>USA</b:CompanyName>
<b:CompanyUid>1152921504606850739</b:CompanyUid>
<b:CompanyNumber>USA</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>Executive Team (USA)</b:CostCenterName>
<b:CostCenterNumber>Executive Team (USA)</b:CostCenterNumber>
<b:CostCenterUid>1152921504606867363</b:CostCenterUid>
</b:CostCenterIdentity>
<b:CreatedByUser>
<b:UserDisplayName>Bettina</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>QA - 01</b:UserReferenceSystemId>
<b:UserUid>1152921504607011056</b:UserUid>
<b:EmailAddress>bettina@projectorpsa.com</b:EmailAddress>
<b:FirstName>Bettina</b:FirstName>
<b:LastName>Borces</b:LastName>
<b:MiddleName i:nil="true"/>
</b:CreatedByUser>
<b:CreatedTimestamp>2022-07-12T15:26:19.99Z</b:CreatedTimestamp>
<b:DeletedFlag>false</b:DeletedFlag>
<b:DraftCostCardCount>0</b:DraftCostCardCount>
<b:DraftInvoiceNumber>DRAFT00764</b:DraftInvoiceNumber>
<b:DraftTimeCardCount>0</b:DraftTimeCardCount>
<b:Engagement>
<b:EngagementCode>P001666</b:EngagementCode>
<b:EngagementId i:nil="true"/>
<b:EngagementUid>1152921504607393774</b:EngagementUid>
<b:ClientIdentity>
<b:ClientId i:nil="true"/>
<b:ClientNumber>AMAZON</b:ClientNumber>
<b:ClientUid>1152921504606971723</b:ClientUid>
</b:ClientIdentity>
<b:EngagementName>R23 - 2022</b:EngagementName>
</b:Engagement>
<b:ExcludeZeroAmountCostCardsFlag>false</b:ExcludeZeroAmountCostCardsFlag>
<b:ExcludeZeroAmountTimeCardsFlag>false</b:ExcludeZeroAmountTimeCardsFlag>
<b:ExcludedCostCardAmount>10</b:ExcludedCostCardAmount>
<b:ExcludedCostCardCount>1</b:ExcludedCostCardCount>
<b:ExcludedMilestoneAmount>0</b:ExcludedMilestoneAmount>
<b:ExcludedMilestoneCount>0</b:ExcludedMilestoneCount>
<b:ExcludedTimeCardAmount>800</b:ExcludedTimeCardAmount>
<b:ExcludedTimeCardCount>1</b:ExcludedTimeCardCount>
<b:GrossInvoiceAmount>0</b:GrossInvoiceAmount>
<b:IncludedCostCardCount>0</b:IncludedCostCardCount>
<b:IncludedMilestoneCount>0</b:IncludedMilestoneCount>
<b:IncludedMilestones/>
<b:IncludedTimeCardCount>0</b:IncludedTimeCardCount>
<b:InvoiceContent>B</b:InvoiceContent>
<b:InvoiceCurrencyDecimalDigits>2</b:InvoiceCurrencyDecimalDigits>
<b:InvoiceCurrencyIdentity>
<b:CurrencyCode>USD</b:CurrencyCode>
<b:CurrencyId i:nil="true"/>
<b:CurrencyUid>1152921504606851838</b:CurrencyUid>
</b:InvoiceCurrencyIdentity>
<b:InvoiceDetail>
<b:InvoiceId i:nil="true"/>
<b:InvoiceNumber>DRAFT00764</b:InvoiceNumber>
<b:InvoiceUid>1152921504607847047</b:InvoiceUid>
<b:InvoiceDate i:nil="true"/>
<b:InvoiceName>Invoice - WS</b:InvoiceName>
<b:BillingAddress>
<b:AddressLine1>98 N. Washingtong Street</b:AddressLine1>
<b:AddressLine2>Suite 400</b:AddressLine2>
<b:Attention i:nil="true"/>
<b:City>Boston</b:City>
<b:CompanyName>R23</b:CompanyName>
<b:Country>USA</b:Country>
<b:StateOrProvince>MA</b:StateOrProvince>
<b:ZipOrPostalCode>02130</b:ZipOrPostalCode>
</b:BillingAddress>
<b:BillingCultureIdentity>
<b:CultureId i:nil="true"/>
<b:CultureName>en-US</b:CultureName>
<b:CultureUid>1152921504606851419</b:CultureUid>
</b:BillingCultureIdentity>
<b:BillingInstructions i:nil="true"/>
<b:ClientMessage i:nil="true"/>
<b:ClientMessagePlain i:nil="true"/>
<b:ContractLineItems/>
<b:CostGrossAmtOption>C</b:CostGrossAmtOption>
<b:DistributionSettings>
<b:EmailSettings>
<b:EmailFromUserIdentity>
<b:UserDisplayName>Bettina</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>QA - 01</b:UserReferenceSystemId>
<b:UserUid>1152921504607011056</b:UserUid>
</b:EmailFromUserIdentity>
<b:EmailInvoiceTemplateIdentity>
<b:InvoiceTemplateId i:nil="true"/>
<b:InvoiceTemplateName>E001</b:InvoiceTemplateName>
<b:InvoiceTemplateUid>1152921504606878906</b:InvoiceTemplateUid>
</b:EmailInvoiceTemplateIdentity>
<b:InvoiceEmailEnabledFlag>true</b:InvoiceEmailEnabledFlag>
<b:InvoiceEmailType>W</b:InvoiceEmailType>
<b:Recipients>
<b:PwsInvoiceEmailRecipient>
<b:RecipientType>T</b:RecipientType>
<b:UserIdentity>
<b:UserDisplayName>Fitzgerald Grant</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>Client11</b:UserReferenceSystemId>
<b:UserUid>1152921504607061857</b:UserUid>
</b:UserIdentity>
</b:PwsInvoiceEmailRecipient>
</b:Recipients>
</b:EmailSettings>
<b:SubjectText>Invoice - WS</b:SubjectText>
</b:DistributionSettings>
<b:InvoiceMessages>[Bettina, 12 Jul 2022 11:26 (Create Invoice)] Invoice - WS</b:InvoiceMessages>
<b:InvoiceTemplateIdentity>
<b:InvoiceTemplateId i:nil="true"/>
<b:InvoiceTemplateName>A100</b:InvoiceTemplateName>
<b:InvoiceTemplateUid>1152921504606878901</b:InvoiceTemplateUid>
</b:InvoiceTemplateIdentity>
<b:OverrideAccountingPeriodIdentity i:nil="true"/>
<b:PaymentTermIdentity>
<b:PaymentTermId i:nil="true"/>
<b:PaymentTermName>Net 15</b:PaymentTermName>
<b:PaymentTermUid>1152921504606856053</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>AAAAAB4/Y0s=</b:Timestamp>
</b:InvoiceDetail>
<b:InvoiceNumberHistory>DRAFT00764</b:InvoiceNumberHistory>
<b:InvoiceRecipients>
<b:PwsUserSummary>
<b:UserDisplayName>Bettina</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>QA - 01</b:UserReferenceSystemId>
<b:UserUid>1152921504607011056</b:UserUid>
<b:EmailAddress>bettina@projectorpsa.com</b:EmailAddress>
<b:FirstName>Bettina</b:FirstName>
<b:LastName>Borces</b:LastName>
<b:MiddleName i:nil="true"/>
</b:PwsUserSummary>
<b:PwsUserSummary>
<b:UserDisplayName>Fitzgerald Grant</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>Client11</b:UserReferenceSystemId>
<b:UserUid>1152921504607061857</b:UserUid>
<b:EmailAddress>fitzgerald@usagov.bb</b:EmailAddress>
<b:FirstName>Fitzgerald</b:FirstName>
<b:LastName>Grant</b:LastName>
<b:MiddleName i:nil="true"/>
</b:PwsUserSummary>
</b:InvoiceRecipients>
<b:InvoiceScope>P</b:InvoiceScope>
<b:InvoiceStatus>D</b:InvoiceStatus>
<b:IssuedByUser i:nil="true"/>
<b:IssuedTimestamp i:nil="true"/>
<b:LastUpdatedByUser>
<b:UserDisplayName>Bettina</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>QA - 01</b:UserReferenceSystemId>
<b:UserUid>1152921504607011056</b:UserUid>
<b:EmailAddress>bettina@projectorpsa.com</b:EmailAddress>
<b:FirstName>Bettina</b:FirstName>
<b:LastName>Borces</b:LastName>
<b:MiddleName i:nil="true"/>
</b:LastUpdatedByUser>
<b:LastUpdatedTimestamp>2022-07-12T15:26:19.99Z</b:LastUpdatedTimestamp>
<b:ManagementApprovalThresholdAmount>10</b:ManagementApprovalThresholdAmount>
<b:ManagementApprovalThresholdPercent>0.5</b:ManagementApprovalThresholdPercent>
<b:MilestoneInvoicedAmount>0</b:MilestoneInvoicedAmount>
<b:NetInvoiceAmount>0</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>
<b:ProjectCode>P001666-001</b:ProjectCode>
<b:ProjectId i:nil="true"/>
<b:ProjectUid>1152921504607524352</b:ProjectUid>
<b:EngagementIdentity>
<b:EngagementCode>P001666</b:EngagementCode>
<b:EngagementId i:nil="true"/>
<b:EngagementUid>1152921504607393774</b:EngagementUid>
</b:EngagementIdentity>
<b:ProjectName>R23 - Time and Materials</b:ProjectName>
</b:Project>
<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>0</b:TimeCardInvoicedAmount>
<b:TimeCardRequireLocationFlag>false</b:TimeCardRequireLocationFlag>
<b:UnapprovedCostCardCount>0</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>
<a:InvoiceIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:InvoiceId i:nil="true"/>
<b:InvoiceNumber>DRAFT00764</b:InvoiceNumber>
<b:InvoiceUid>1152921504607847047</b:InvoiceUid>
</a:InvoiceIdentity>
<a:InvoiceTimestamp>AAAAAB4/Y0s=</a:InvoiceTimestamp>
</PwsCreateInvoiceResult>
</PwsCreateInvoiceResponse>
</s:Body>
</s:Envelope> |
...
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 10111 | RequiredFieldMissing | A required field is missing: BillingCultureIdentity. |
| 10115 | FieldExceedsMaxLength | The value specified in the field "InvoiceName" in the class "PwsCandidateInvoiceSpec" exceeds the maximum allowable length of 100 characters. |
| 10126 | InvalidEnumerationValueSpecified | An invalid value was specified for EngagementInvoiceContent. Valid values are B, S. |
| 10126 | InvalidEnumerationValueSpecified | An invalid value was specified for InvoiceContent. Valid values are B, F, A, M, S, C, T. |
| 10126 | InvalidEnumerationValueSpecified | An invalid value was specified for InvoiceScope. Valid values are C, E, N, P. |
| 50024 | EntityNotFound | Project was not found. Another user may have deleted it. |
| 57528 | CultureNotValidForAccount | Error 57528, State 1: Specified culture not valid for this installation (installation = 2378, culture name = en-USA, culture number = (null)) |
| 50046 | UpdatePermissionDenied | You do not have permission to update this item. |
...