Overview

This web service retrieves a list of project summary records (PwsAccountingPeriodSummary), based on specified search criteria. For example, the following parameters affect the list of accounting periods retrieved:

QueryString: Find all accounting periods matching specified string in accounting period code or name
AccountingPeriodIdentity: If specified, the identified accounting period will be returned. And QueryString will be ignored.

Request Format

PwsGetAccountingPeriodList Request

PwsGetAccountingPeriodList
- serviceRequest: PwsGetAccountingPeriodListRq
  - RequestId: Int32
  - SessionTicket: String
  - AccountingPeriodIdentity: PwsAccountingPeriodRef
  - IncludeFullyClosedFlag: Boolean
  - IncludeOpenForAdjustmentsFlag: Boolean
  - IncludeOpenForApTransactionsFlag: Boolean
  - IncludeOpenForArTransactionsFlag: Boolean
  - IncludeOpenForCostFlag: Boolean
  - IncludeOpenForGlTransactionsFlag: Boolean
  - IncludeOpenForTimeFlag: Boolean
  - MaxRowsToReturn: Int32
  - QueryString: String
  - CompanyIdentity: PwsCompanyRef

Request Elements

Element	Data Type	Description
RequestId	Int32	Click here for more information.
SessionTicket	String	Click here for more information.
AccountingPeriodIdentity	PwsAccountingPeriodRef
IncludeFullyClosedFlag	Boolean
IncludeOpenForAdjustmentsFlag	Boolean
IncludeOpenForApTransactionsFlag	Boolean
IncludeOpenForArTransactionsFlag	Boolean
IncludeOpenForCostFlag	Boolean
IncludeOpenForGlTransactionsFlag	Boolean
IncludeOpenForTimeFlag	Boolean
MaxRowsToReturn	Int32
QueryString	String
CompanyIdentity	PwsCompanyRef

Usage Example(s)

Example 01 - Accounting period is not specified

</soapenv:Envelope>

Example 02 - Accounting period is specified

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetAccountingPeriodList>
         <pws:serviceRequest>
            <req:SessionTicket>ATtU220EvBSE2+GCN9U58g==</req:SessionTicket>
            <req:AccountingPeriodIdentity>
               <com:AccountingPeriodCode>-062018</com:AccountingPeriodCode>
            </req:AccountingPeriodIdentity>
            <req:IncludeFullyClosedFlag>true</req:IncludeFullyClosedFlag>
            <req:IncludeOpenForAdjustmentsFlag>true</req:IncludeOpenForAdjustmentsFlag>
            <req:IncludeOpenForApTransactionsFlag>true</req:IncludeOpenForApTransactionsFlag>
            <req:IncludeOpenForArTransactionsFlag>true</req:IncludeOpenForArTransactionsFlag>
            <req:IncludeOpenForCostFlag>true</req:IncludeOpenForCostFlag>
            <req:IncludeOpenForGlTransactionsFlag>true</req:IncludeOpenForGlTransactionsFlag>
            <req:IncludeOpenForTimeFlag>true</req:IncludeOpenForTimeFlag>
            <req:MaxRowsToReturn>5</req:MaxRowsToReturn>
            <req:QueryString></req:QueryString>
         </pws:serviceRequest>
      </pws:PwsGetAccountingPeriodList>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetAccountingPeriodList Response

PwsGetAccountingPeriodListResponse
- PwsGetAccountingPeriodListResult: PwsGetAccountingPeriodListRs
  - Messages: PwsMessage
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - AccountingPeriods: PwsAccountingPeriodSummary

Response Elements

Element	Data Type	Description	Sample Data
Messages	PwsMessage
ResponseId	Int32	Click here for more information.
Status	RequestStatus	Click here for more information	Ok
ServerTimestampUtc	DateTime	Click here for more information.
AccountingPeriods	PwsAccountingPeriodSummary

Usage Example(s)

Example 01 - Accounting period is not specified

</s:Envelope>

Example 02 - Accounting period is specified

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetAccountingPeriodList>
         <pws:serviceRequest>
            <req:SessionTicket>ATtU220EvBSE2+GCN9U58g==</req:SessionTicket>
            <req:AccountingPeriodIdentity>
               <com:AccountingPeriodCode>-062018</com:AccountingPeriodCode>
            </req:AccountingPeriodIdentity>
            <req:IncludeFullyClosedFlag>true</req:IncludeFullyClosedFlag>
            <req:IncludeOpenForAdjustmentsFlag>true</req:IncludeOpenForAdjustmentsFlag>
            <req:IncludeOpenForApTransactionsFlag>true</req:IncludeOpenForApTransactionsFlag>
            <req:IncludeOpenForArTransactionsFlag>true</req:IncludeOpenForArTransactionsFlag>
            <req:IncludeOpenForCostFlag>true</req:IncludeOpenForCostFlag>
            <req:IncludeOpenForGlTransactionsFlag>true</req:IncludeOpenForGlTransactionsFlag>
            <req:IncludeOpenForTimeFlag>true</req:IncludeOpenForTimeFlag>
            <req:MaxRowsToReturn>5</req:MaxRowsToReturn>
            <req:QueryString></req:QueryString>
         </pws:serviceRequest>
      </pws:PwsGetAccountingPeriodList>
   </soapenv:Body>
</soapenv:Envelope>

Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorNumber	ErrorCode	Description