...
This web service retrieves a list of project summary records (PwsProjectSummaryaccounting period summaries (PwsAccountingPeriodSummary), based on specified search criteria. The For example, the following parameters affect the list of engagements accounting periods retrieved:
- QueryString: Find all projects accounting periods matching specified string in project's code or name, associated contract line item code or name, the associated engagement code or name, or the client name or number for the associated engagement's client or any parent client thereof.
- IncludeClosedFlag: If set to 'true', projects that are open or closed according to the project stage settings will be returned. Otherwise, only projects that are considered not closed will be returned.
- ProjectIdentity: If specified, the identified engagement will be returned. And QueryString and IncludeClosedFlag will be in accounting period code or name
- AccountingPeriodIdentity: If specified, the identified accounting period will be returned (QueryString will be ignored).
This request also has seven flag filters that can further determine which accounting periods to be included. Five of the flags (indicated by asterisks below) apply to operations that are company based. They are
- IncludeOpenForAdjustmentsFlag
- IncludeOpenForApTransactionsFlag *
- IncludeOpenForArTransactionsFlag *
- IncludeOpenForCostFlag *
- IncludeOpenForGlTransactionsFlag *
- IncludeOpenForTimeFlag *
- IncludeFullyClosedFlag
If CompanyIdentity is omitted, the flags marked with asterisks are ignored.
Request Format
| Panel | ||
|---|---|---|
| ||
|
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== | |
AccountingPeriodIdentity | No | The identity of a single accounting period to be retrieved. If this is specified, all other criteria is ignored. Click here for more information. | |||
IncludeFullyClosedFlag | Boolean | No | false | If set to 'true', accounting periods closed for all activity will be included in the results, provided they meet any other criteria specified. Note that if no CompanyIdentity is specified, this flag only applies to the open for adjustments flag and, if set to 'true', will cause all accounting periods not open for adjustments to be included in the response. | false |
IncludeOpenForAdjustmentsFlag | Boolean | No | false | If set to 'true', accounting periods that are open time/cost adjustments are included in the response. This filter is not company based. | false |
IncludeOpenForApTransactionsFlag | Boolean | No | false | If a CompanyIdentity is omitted, this flag is ignored. Otherwise if set to 'true', accounting periods that are open for AP transactions are included in the response. | false |
IncludeOpenForArTransactionsFlag | Boolean | No | false | If a CompanyIdentity is omitted, this flag is ignored. Otherwise if set to 'true', accounting periods that are open for AR transactions are included in the response. | false |
IncludeOpenForCostFlag | Boolean | No | false | If a CompanyIdentity is omitted, this flag is ignored. Otherwise if set to 'true', accounting periods that are open for cost entry are included in the response. | false |
IncludeOpenForGlTransactionsFlag | Boolean | No | false | If a CompanyIdentity is omitted, this flag is ignored. Otherwise if set to 'true', accounting periods that are open for GL transactions are included in the response. | false |
IncludeOpenForTimeFlag | Boolean | No | false | If a CompanyIdentity is omitted, this flag is ignored. Otherwise if set to 'true', accounting periods that are open for time entry are included in the response. | false |
MaxRowsToReturn | Int32 | No | The maximum number of accounting periods to be retrieved. This flag is disregarded if an accounting period is specified in AccountingPeriodIdentity. | 5 | |
QueryString | String | No | A search string to narrow down the results. An accounting period will be included in the results if the search string matches the accounting period's code or name. | Rev | |
CompanyIdentity | No | The identity of a company for determining whether the accounting period is open for time, cost, AP transactions, AR transactions and/or GL transactions for filtering purposes. |
Usage Example(s)
| 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:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsGetAccountingPeriodList>
<pws:serviceRequest>
<req:SessionTicket>ATtU220EvBSE2+GCN9U58g==</req:SessionTicket>
<req:IncludeOpenForAdjustmentsFlag>false</req:IncludeOpenForAdjustmentsFlag>
<req:IncludeOpenForApTransactionsFlag>true</req:IncludeOpenForApTransactionsFlag>
<req:IncludeOpenForArTransactionsFlag>false</req:IncludeOpenForArTransactionsFlag>
<req:IncludeOpenForCostFlag>true</req:IncludeOpenForCostFlag>
<req:IncludeOpenForGlTransactionsFlag>true</req:IncludeOpenForGlTransactionsFlag>
<req:IncludeOpenForTimeFlag>true</req:IncludeOpenForTimeFlag>
<req:MaxRowsToReturn>5</req:MaxRowsToReturn>
<req:CompanyIdentity>
<com:CompanyName>Revolutionary Solutions Corporation CA</com:CompanyName>
</req:CompanyIdentity>
</pws:serviceRequest>
</pws:PwsGetAccountingPeriodList>
</soapenv:Body>
</soapenv:Envelope> |
| 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: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>01~06-2018</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
...
| 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. | 0 |
| Status | RequestStatus | Click here for more information | Ok |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-03-13T19:42:22.6252189Z |
AccountingPeriods | The accounting period summary records that were fetched by the service. Click here for more information. |
Usage Example(s)
Fig 1. Accounting periods for Example 01 - Accounting period is not specified.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <PwsGetAccountingPeriodListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/"> <PwsGetAccountingPeriodListResult xmlns:a="http://projectorpsa.com/DataContracts/Requests/" 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-15T15:03:37.4306662Z</ServerTimestampUtc> <a:AccountingPeriods xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:PwsAccountingPeriodSummary> <b:AccountingPeriodCode>01~06-2018</b:AccountingPeriodCode> <b:AccountingPeriodId i:nil="true"/> <b:AccountingPeriodName>Jan-Jun2018</b:AccountingPeriodName> <b:AccountingPeriodUid>1152921504606866570</b:AccountingPeriodUid> <b:BeginDate>2018-01-01T00:00:00</b:BeginDate> <b:EndDate>2018-06-30T00:00:00</b:EndDate> <b:OpenForAdjustmentsFlag>true</b:OpenForAdjustmentsFlag> <b:OpenForApTransactionsFlag>true</b:OpenForApTransactionsFlag> <b:OpenForArTransactionsFlag>false</b:OpenForArTransactionsFlag> <b:OpenForCostFlag>false</b:OpenForCostFlag> <b:OpenForGlTransactionsFlag>false</b:OpenForGlTransactionsFlag> <b:OpenForTimeFlag>false</b:OpenForTimeFlag> </b:PwsAccountingPeriodSummary> <b:PwsAccountingPeriodSummary> <b:AccountingPeriodCode>07~12-2017</b:AccountingPeriodCode> <b:AccountingPeriodId i:nil="true"/> <b:AccountingPeriodName>Jul-Dec2017</b:AccountingPeriodName> <b:AccountingPeriodUid>1152921504606866569</b:AccountingPeriodUid> <b:BeginDate>2017-07-01T00:00:00</b:BeginDate> <b:EndDate>2017-12-31T00:00:00</b:EndDate> <b:OpenForAdjustmentsFlag>true</b:OpenForAdjustmentsFlag> <b:OpenForApTransactionsFlag>true</b:OpenForApTransactionsFlag> <b:OpenForArTransactionsFlag>true</b:OpenForArTransactionsFlag> <b:OpenForCostFlag>false</b:OpenForCostFlag> <b:OpenForGlTransactionsFlag>true</b:OpenForGlTransactionsFlag> <b:OpenForTimeFlag>true</b:OpenForTimeFlag> </b:PwsAccountingPeriodSummary> <b:PwsAccountingPeriodSummary> <b:AccountingPeriodCode>01~06-2017</b:AccountingPeriodCode> <b:AccountingPeriodId i:nil="true"/> <b:AccountingPeriodName>Jan-Jun2017</b:AccountingPeriodName> <b:AccountingPeriodUid>1152921504606866568</b:AccountingPeriodUid> <b:BeginDate>2017-01-01T00:00:00</b:BeginDate> <b:EndDate>2017-06-30T00:00:00</b:EndDate> <b:OpenForAdjustmentsFlag>false</b:OpenForAdjustmentsFlag> <b:OpenForApTransactionsFlag>true</b:OpenForApTransactionsFlag> <b:OpenForArTransactionsFlag>true</b:OpenForArTransactionsFlag> <b:OpenForCostFlag>true</b:OpenForCostFlag> <b:OpenForGlTransactionsFlag>true</b:OpenForGlTransactionsFlag> <b:OpenForTimeFlag>true</b:OpenForTimeFlag> </b:PwsAccountingPeriodSummary> <b:PwsAccountingPeriodSummary> <b:AccountingPeriodCode>07~12-2016</b:AccountingPeriodCode> <b:AccountingPeriodId i:nil="true"/> <b:AccountingPeriodName>Jul-Dec2016</b:AccountingPeriodName> <b:AccountingPeriodUid>1152921504606866567</b:AccountingPeriodUid> <b:BeginDate>2016-07-01T00:00:00</b:BeginDate> <b:EndDate>2016-12-31T00:00:00</b:EndDate> <b:OpenForAdjustmentsFlag>false</b:OpenForAdjustmentsFlag> <b:OpenForApTransactionsFlag>false</b:OpenForApTransactionsFlag> <b:OpenForArTransactionsFlag>false</b:OpenForArTransactionsFlag> <b:OpenForCostFlag>false</b:OpenForCostFlag> <b:OpenForGlTransactionsFlag>true</b:OpenForGlTransactionsFlag> <b:OpenForTimeFlag>false</b:OpenForTimeFlag> </b:PwsAccountingPeriodSummary> <b:PwsAccountingPeriodSummary> <b:AccountingPeriodCode>01~06-2016</b:AccountingPeriodCode> <b:AccountingPeriodId i:nil="true"/> <b:AccountingPeriodName>Jan-Jun2016</b:AccountingPeriodName> <b:AccountingPeriodUid>1152921504606866111</b:AccountingPeriodUid> <b:BeginDate>2016-01-01T00:00:00</b:BeginDate> <b:EndDate>2016-06-30T00:00:00</b:EndDate> <b:OpenForAdjustmentsFlag>true</b:OpenForAdjustmentsFlag> <b:OpenForApTransactionsFlag>true</b:OpenForApTransactionsFlag> <b:OpenForArTransactionsFlag>false</b:OpenForArTransactionsFlag> <b:OpenForCostFlag>true</b:OpenForCostFlag> <b:OpenForGlTransactionsFlag>true</b:OpenForGlTransactionsFlag> <b:OpenForTimeFlag>true</b:OpenForTimeFlag> </b:PwsAccountingPeriodSummary> </a:AccountingPeriods> </PwsGetAccountingPeriodListResult> </PwsGetAccountingPeriodListResponse> </s:Body> </s:Envelope> |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
</s:Envelope> | ||||||
<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> |
PwsGetAccountingPeriodList - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | Description |
|---|---|---|
| 57335 | AccountingPeriodNotFound | The specified accounting period was not found. |
| 57339 | CompanyNotFound | The specified company was not found. |