PwsGetInvoice
Bettina Borces
Min Zeng
Overview
This web service can be used to retrieve an invoice. Note that this service will retrieve invoices created on the web and management apps.
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
- PwsGetInvoiceRq
- RequestId: Int32
- SessionTicket: String
- IncludeAdjustmentHistoryFlag: Boolean
- IncludeFullAdjustmentHistoryFlag: Boolean
- InvoiceIdentity: PwsInvoiceRef
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
Int32 | No | Click here for more information. | 1 | ||
String | Yes | Click here for more information. | AT0Wkw45/5xiaJ8It3xxkA== | ||
IncludeAdjustmentHistoryFlag | Boolean | No | false | True to include adjustment history in invoice detail | true |
IncludeFullAdjustmentHistoryFlag | Boolean | No | false | If IncludeAdjustmentHistoryFlag is set, true to include full card breakdown with each adjustment history record. | true |
InvoiceIdentity | Yes | This structure represents the unique key fields associated with identifying an invoice . |
Request Usage Example(s)
<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> <pws:serviceRequest> <req:RequestId>1</req:RequestId> <req:SessionTicket>AT0Wkw45/5xiaJ8It3xxkA==</req:SessionTicket> <bil:IncludeAdjustmentHistoryFlag>true</bil:IncludeAdjustmentHistoryFlag> <bil:IncludeFullAdjustmentHistoryFlag>true</bil:IncludeFullAdjustmentHistoryFlag> <bil:InvoiceIdentity> <com:InvoiceNumber>DRAFT00763</com:InvoiceNumber> </bil:InvoiceIdentity> </pws:serviceRequest> </pws:PwsGetInvoice> </soapenv:Body> </soapenv:Envelope>
Response Format
- PwsGetInvoiceRs
- Messages: PwsMessage[]
- ResponseId: Int32
- RequestStatus: RequestStatus
- ServerTimestampUtc: DateTime
- Invoice: PwsInvoiceElement
Response Elements
Element | Data Type | Description | Sample Data |
---|---|---|---|
Messages | The web service response status and message. Click here for more information | ||
Int32 | Click here for more information | ||
Status | Click here for more information | ||
DateTime | Click here for more information. | ||
Invoice | The set of basic information about an invoice |
Response Usage Example(s)
<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/">1</ResponseId> <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status> <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2022-07-18T14:49:51.3296273Z</ServerTimestampUtc> <a:Invoice xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:AdjustmentHistory> <b:PwsInvoiceAdjustmentHistory> <b:AdjustedCostCards/> <b:AdjustedTimeCards> <b:PwsInvoiceAdjustmentHistoryTimeCard> <b:CardDate>2022-04-01T00:00:00Z</b:CardDate> <b:CardId i:nil="true"/> <b:CardUid>1152921504661672589</b:CardUid> <b:ResourceIdentity> <b:ResourceDisplayName>Olivia</b:ResourceDisplayName> <b:ResourceId i:nil="true"/> <b:ResourceReferenceSystemId>OPA - 01</b:ResourceReferenceSystemId> <b:ResourceUid>1152921504607069154</b:ResourceUid> </b:ResourceIdentity> <b:AfterImage> <b:BillingAdjustedAmount>100</b:BillingAdjustedAmount> <b:ContractRevenueAmount>100</b:ContractRevenueAmount> <b:DayFraction>0.125</b:DayFraction> <b:Description i:nil="true"/> <b:LocationIdentity i:nil="true"/> <b:MinutesPerDay>480</b:MinutesPerDay> <b:ProjectIdentity> <b:ProjectCode>P001670-001</b:ProjectCode> <b:ProjectId i:nil="true"/> <b:ProjectUid>1152921504607525308</b:ProjectUid> </b:ProjectIdentity> <b:ProjectName>R23 - April 2022</b:ProjectName> <b:ProjectRateTypeIdentity> <b:ExternalSystemIdentifier i:nil="true"/> <b:ProjectRateTypeId i:nil="true"/> <b:ProjectRateTypeUid>1152921504607565156</b:ProjectRateTypeUid> </b:ProjectRateTypeIdentity> <b:ProjectRateTypeName>Regular</b:ProjectRateTypeName> <b:ProjectRoleIdentity> <b:ExternalSystemIdentifier i:nil="true"/> <b:ProjectRoleId i:nil="true"/> <b:ProjectRoleUid>1152921504610173756</b:ProjectRoleUid> </b:ProjectRoleIdentity> <b:ProjectRoleName>Subcontractor - Olivia</b:ProjectRoleName> <b:ProjectTaskFullName>1 Default Task</b:ProjectTaskFullName> <b:ProjectTaskIdentity> <b:ExternalSystemIdentifier i:nil="true"/> <b:ProjectTaskId i:nil="true"/> <b:ProjectTaskUid>1152921504609354095</b:ProjectTaskUid> </b:ProjectTaskIdentity> <b:Udf1Value> <b:BooleanValue i:nil="true"/> <b:DateValue i:nil="true"/> <b:IntegerValue i:nil="true"/> <b:TextValue i:nil="true"/> <b:RelationValue i:nil="true"/> <b:NumericValue i:nil="true"/> </b:Udf1Value> <b:Udf2Value> <b:BooleanValue i:nil="true"/> <b:DateValue i:nil="true"/> <b:IntegerValue i:nil="true"/> <b:TextValue i:nil="true"/> <b:RelationValue i:nil="true"/> <b:NumericValue i:nil="true"/> </b:Udf2Value> <b:WorkMinutes>60</b:WorkMinutes> </b:AfterImage> <b:BeforeImage i:nil="true"/> </b:PwsInvoiceAdjustmentHistoryTimeCard> </b:AdjustedTimeCards> <b:AdjustmentCodeIdentity i:nil="true"/> <b:AdjustmentHistoryId i:nil="true"/> <b:AdjustmentHistoryUid>1152921504610161740</b:AdjustmentHistoryUid> <b:AdjustmentSubtype i:nil="true"/> <b:AdjustmentType>IT</b:AdjustmentType> <b:AfterAdjustmentCardValue>100</b:AfterAdjustmentCardValue> <b:BeforeAdjustmentCardValue>100</b:BeforeAdjustmentCardValue> <b:CardCount>1</b:CardCount> <b:EnteredByUser> <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:EnteredByUser> <b:Explanation i:nil="true"/> <b:TransactionTimestamp>2022-04-27T14:43:32.63Z</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>P001670-CL1</b:ContractLineItemCode> <b:ContractLineItemId i:nil="true"/> <b:ContractLineItemUid>1152921504607167865</b:ContractLineItemUid> <b:ContractLineItemName>R23 - April 2022</b:ContractLineItemName> <b:EngagementIdentity> <b:EngagementCode>P001670</b:EngagementCode> <b:EngagementId i:nil="true"/> <b:EngagementUid>1152921504607394451</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>C000161</b:ClientNumber> <b:ClientUid>1152921504607020056</b:ClientUid> <b:ClientName>Société Privée de Gérance (SPG-Rytz)</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-04-27T14:43:32.603Z</b:CreatedTimestamp> <b:DeletedFlag>false</b:DeletedFlag> <b:DraftCostCardCount>1</b:DraftCostCardCount> <b:DraftInvoiceNumber>DRAFT00763</b:DraftInvoiceNumber> <b:DraftTimeCardCount>0</b:DraftTimeCardCount> <b:Engagement> <b:EngagementCode>P001670</b:EngagementCode> <b:EngagementId i:nil="true"/> <b:EngagementUid>1152921504607394451</b:EngagementUid> <b:ClientIdentity> <b:ClientId i:nil="true"/> <b:ClientNumber>C000161</b:ClientNumber> <b:ClientUid>1152921504607020056</b:ClientUid> </b:ClientIdentity> <b:EngagementName>R23 - April 2022</b:EngagementName> </b:Engagement> <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>100</b:GrossInvoiceAmount> <b:IncludedCostCardCount>0</b:IncludedCostCardCount> <b:IncludedMilestoneCount>0</b:IncludedMilestoneCount> <b:IncludedMilestones/> <b:IncludedTimeCardCount>1</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>1152921504606851838</b:CurrencyUid> </b:InvoiceCurrencyIdentity> <b:InvoiceDetail> <b:InvoiceId i:nil="true"/> <b:InvoiceNumber>DRAFT00763</b:InvoiceNumber> <b:InvoiceUid>1152921504607826901</b:InvoiceUid> <b:InvoiceDate i:nil="true"/> <b:InvoiceName>R23 - April 2022</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:PwsInvoiceContractLineItem> <b:AppliedPrepaidAmount>0</b:AppliedPrepaidAmount> <b:ContractLineItemIdentity> <b:ContractLineItemCode>P001670-CL1</b:ContractLineItemCode> <b:ContractLineItemId i:nil="true"/> <b:ContractLineItemUid>1152921504607167865</b:ContractLineItemUid> </b:ContractLineItemIdentity> </b:PwsInvoiceContractLineItem> </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>R23 - April 2022</b:SubjectText> </b:DistributionSettings> <b:InvoiceMessages i:nil="true"/> <b:InvoiceTemplateIdentity> <b:InvoiceTemplateId i:nil="true"/> <b:InvoiceTemplateName>A200</b:InvoiceTemplateName> <b:InvoiceTemplateUid>1152921504606878904</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>AAAAAB0LWok=</b:Timestamp> </b:InvoiceDetail> <b:InvoiceNumberHistory>DRAFT00763</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-04-27T14:43:32.603Z</b:LastUpdatedTimestamp> <b:ManagementApprovalThresholdAmount>10</b:ManagementApprovalThresholdAmount> <b:ManagementApprovalThresholdPercent>0.5</b:ManagementApprovalThresholdPercent> <b:MilestoneInvoicedAmount>0</b:MilestoneInvoicedAmount> <b:NetInvoiceAmount>100</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>P001670-001</b:ProjectCode> <b:ProjectId i:nil="true"/> <b:ProjectUid>1152921504607525308</b:ProjectUid> <b:EngagementIdentity> <b:EngagementCode>P001670</b:EngagementCode> <b:EngagementId i:nil="true"/> <b:EngagementUid>1152921504607394451</b:EngagementUid> </b:EngagementIdentity> <b:ProjectName>R23 - April 2022</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>100</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> </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. |