Overview
This web service retrieves a list of posted invoices (PwsPostedInvoice), based on specified project (PwsProjectRef). Supporting documents and links uploaded or created separately will also be included.
Request Format
- PwsGetPostedInvoices
- serviceRequest: PwsGetPostedInvoicesRq
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. | ATtU220EvBSE2+GCN9U58g== |
ProjectIdentity | PwsProjectRef | Yes |
| The project that the posted invoices belong to. Click here for more information. |
|
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:web="http://projectorpsa.com/DataContracts/Shared/Web/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsGetPostedInvoices>
<pws:serviceRequest>
<req:SessionTicket>ATtU220EvBSE2+GCN9U58g==</req:SessionTicket>
<web:ProjectIdentity>
<com:ProjectCode>P001053-001</com:ProjectCode>
</web:ProjectIdentity>
</pws:serviceRequest>
</pws:PwsGetPostedInvoices>
</soapenv:Body>
</soapenv:Envelope>
Response Format
- PwsGetPostedInvoicesResponse
- PwsGetPostedInvoicesResult: PwsGetPostedInvoicesRs
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-12T17:37:24.0896769Z |
InvoiceMessage | String (255) | The invoice tab message for this specified project. | Please pay within 30 days of invoice date. |
PostedInvoices | PwsPostedInvoice[] | The invoices that are posted to this project's workspace. Click here for more information. |
|
Response Usage Example(s)
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsGetPostedInvoicesResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsGetPostedInvoicesResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/Web/" 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-12T17:37:24.0896769Z</ServerTimestampUtc>
<a:InvoiceMessage>Please pay within 30 days of invoice date.</a:InvoiceMessage>
<a:PostedInvoices>
<a:PwsPostedInvoice>
<a:CurrencyIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:CurrencyCode>USD</b:CurrencyCode>
<b:CurrencyId i:nil="true"/>
<b:CurrencyUid>1152921504606849879</b:CurrencyUid>
</a:CurrencyIdentity>
<a:DueDate>2018-04-11T00:00:00Z</a:DueDate>
<a:InvoiceAmount>3565.66</a:InvoiceAmount>
<a:InvoiceDate>2018-03-12T00:00:00Z</a:InvoiceDate>
<a:InvoiceDocumentIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:DocumentRefId i:nil="true"/>
<b:DocumentRefUid>1152921504607652297</b:DocumentRefUid>
</a:InvoiceDocumentIdentity>
<a:InvoiceDocumentMimeType>application/pdf</a:InvoiceDocumentMimeType>
<a:InvoiceFolderIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:FolderId i:nil="true"/>
<b:FolderUid>1152921504607341992</b:FolderUid>
</a:InvoiceFolderIdentity>
<a:InvoiceIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:InvoiceId i:nil="true"/>
<b:InvoiceNumber>INV00087</b:InvoiceNumber>
<b:InvoiceUid>1152921504607603784</b:InvoiceUid>
</a:InvoiceIdentity>
<a:InvoiceName>Parsifal</a:InvoiceName>
<a:InvoiceStatus>U</a:InvoiceStatus>
<a:DocumentName>INV00087.pdf</a:DocumentName>
<a:DocumentUri i:nil="true"/>
</a:PwsPostedInvoice>
</a:PostedInvoices>
</PwsGetPostedInvoicesResult>
</PwsGetPostedInvoicesResponse>
</s:Body>
</s:Envelope>
PwsGetPostedInvoices - Common Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|
23009 | ProjectIdentityRequiredForGetPostedInvoices | A project identity must be specified. |
54282 | ProjectNotFound | Specified project does not exist. |