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

...

title	PwsGetAccountingPeriodList Request

...

).

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

title	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

...

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	PwsAccountingPeriodRef	No		The unique keys used to identify 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 that are closed for all operations are activity will be included in the response. The operations include time entry, cost entry, time/cost adjustment, GL transactions, AP transactions and AR transactions. ???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	IncludeOpenForApTransactionsFlag	Boolean	No	IncludeOpenForArTransactionsFlagIf 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	IncludeOpenForCostFlag	Boolean	No	IncludeOpenForGlTransactionsFlag	Boolean	No	IncludeOpenForTimeFlag	Boolean	No	MaxRowsToReturn	Int32	No	QueryString	String	No	CompanyIdentity	PwsCompanyRef	No

Usage Example(s)

...

language	xml
title	Example 01 - Accounting period is not specified
collapse	true

...

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	PwsCompanyRef	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

language	xml
title	Example 01 - Accounting period is not specified
collapse	true

<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>
         <req:IncludeOpenForTimeFlag>true</req:IncludeOpenForTimeFlag><pws:serviceRequest>
            <req:MaxRowsToReturn>3<SessionTicket>ATtU220EvBSE2+GCN9U58g==</req:MaxRowsToReturn>SessionTicket>
            <req:QueryString><IncludeOpenForAdjustmentsFlag>false</req:QueryString>IncludeOpenForAdjustmentsFlag>
            <<req:IncludeOpenForApTransactionsFlag>true</pws:serviceRequest>req:IncludeOpenForApTransactionsFlag>
            <<req:IncludeOpenForArTransactionsFlag>false</pws:PwsGetAccountingPeriodList>req:IncludeOpenForArTransactionsFlag>
            <<req:IncludeOpenForCostFlag>true</soapenv:Body>
</soapenv:Envelope>

Code Block

language	xml
title	Example 02 - Accounting period is specified
collapse	true

<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>req:IncludeOpenForCostFlag>
            <req:IncludeOpenForGlTransactionsFlag>true</req:IncludeOpenForGlTransactionsFlag>
            <req:IncludeOpenForTimeFlag>true</req:IncludeOpenForTimeFlag>
            <req:MaxRowsToReturn>5</req:MaxRowsToReturn>
          <pws:PwsGetAccountingPeriodList>  <req:CompanyIdentity>
       <pws:serviceRequest>        <com:CompanyName>Revolutionary Solutions    <req:SessionTicket>ATtU220EvBSE2+GCN9U58g==</req:SessionTicket>Corporation CA</com:CompanyName>
            <req</req:AccountingPeriodIdentity>CompanyIdentity>
               <com:AccountingPeriodCode>01~06-2018</com:AccountingPeriodCode></pws:serviceRequest>
        </pws:PwsGetAccountingPeriodList>
   </reqsoapenv:AccountingPeriodIdentity>
            <req:IncludeFullyClosedFlag>true</req:IncludeFullyClosedFlag>
            <req:IncludeOpenForAdjustmentsFlag>true</req:IncludeOpenForAdjustmentsFlag>
            <req:IncludeOpenForApTransactionsFlag>true</req:IncludeOpenForApTransactionsFlag>
            <req:IncludeOpenForArTransactionsFlag>true</req:IncludeOpenForArTransactionsFlag>
  Body>
</soapenv:Envelope>

Code Block

language	xml
title	Example 02 - Accounting period is specified
collapse	true

<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>
         <req:IncludeOpenForCostFlag>true</req:IncludeOpenForCostFlag><pws:serviceRequest>
            <req:IncludeOpenForGlTransactionsFlag>true<SessionTicket>ATtU220EvBSE2+GCN9U58g==</req:IncludeOpenForGlTransactionsFlag>SessionTicket>
            <req:IncludeOpenForTimeFlag>true</req:IncludeOpenForTimeFlag>AccountingPeriodIdentity>
            <req:MaxRowsToReturn>5<   <com:AccountingPeriodCode>01~06-2018</com:AccountingPeriodCode>
            </req:MaxRowsToReturn>AccountingPeriodIdentity>
            <req:QueryString><IncludeFullyClosedFlag>true</req:QueryString>IncludeFullyClosedFlag>
            <<req:IncludeOpenForAdjustmentsFlag>true</pwsreq:serviceRequest>IncludeOpenForAdjustmentsFlag>
        </pws:PwsGetAccountingPeriodList>    <<req:IncludeOpenForApTransactionsFlag>true</soapenvreq:Body>
</soapenv:Envelope>

Response Format

Panel

title	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

...

The web service response status and message. Click here for more information.

...

ResponseId

...

Int32

...

Click here for more information.

...

0

...

ServerTimestampUtc

...

DateTime

...

Click here for more information.

...

2018-03-13T19:42:22.6252189Z

...

AccountingPeriods

...

PwsAccountingPeriodSummary

...

The accounting period summary records that were fetched by the service. Click here for more information.

Usage Example(s)

Code Block

language	xml
title	Example 01 - Accounting period is not specified
collapse	true

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetAccountingPeriodListResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">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

title	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[]	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	PwsAccountingPeriodSummary	The accounting period summary records that were fetched by the service. Click here for more information.

Usage Example(s)

Image Added

Fig 1. Accounting periods for Example 01 - Accounting period is not specified.

Code Block

language	xml
title	Example 01 - Accounting period is not specified
collapse	true

<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>
           <PwsGetAccountingPeriodListResult xmlns:a="http://projectorpsa.com/DataContracts/Requests/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">   <b:PwsAccountingPeriodSummary>
                 <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"><b:AccountingPeriodCode>07~12-2017</b:AccountingPeriodCode>
                  <b:PwsMessage>:AccountingPeriodId i:nil="true"/>
                  <b:AdditionalErrorText>Warning 104: {oldestSurvivingTimeCardWorkDateString}<AccountingPeriodName>Jul-Dec2017</b:AdditionalErrorText>AccountingPeriodName>
                  <b:ErrorCode>RowCountExceeded<AccountingPeriodUid>1152921504606866569</b:ErrorCode>AccountingPeriodUid>
                  <b:ErrorNumber>104<:BeginDate>2017-07-01T00:00:00</b:ErrorNumber>BeginDate>
                  <b:ErrorText>Not all data rows were returned by this request because the specified row count was smaller than the total number of rows available.</b:ErrorText>:EndDate>2017-12-31T00:00:00</b:EndDate>
                  <b:OpenForAdjustmentsFlag>true</b:OpenForAdjustmentsFlag>
                  <b:Type>Warning<OpenForApTransactionsFlag>true</b:Type>OpenForApTransactionsFlag>
                  <<b:OpenForArTransactionsFlag>true</b:PwsMessage>
OpenForArTransactionsFlag>
           </Messages>             <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId><b:OpenForCostFlag>false</b:OpenForCostFlag>
                 <Status xmlns="http<b://projectorpsa.com/CommonServices/">Ok</Status>OpenForGlTransactionsFlag>true</b:OpenForGlTransactionsFlag>
                 <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-13T19:42:22.6252189Z</ServerTimestampUtc><b:OpenForTimeFlag>true</b:OpenForTimeFlag>
              <a:AccountingPeriods xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> </b:PwsAccountingPeriodSummary>
               <b:PwsAccountingPeriodSummary>
                  <b:AccountingPeriodCode>future<AccountingPeriodCode>01~06-2017</b:AccountingPeriodCode>
                  <b:AccountingPeriodId i:nil="true"/>
                  <b:AccountingPeriodName>future<AccountingPeriodName>Jan-Jun2017</b:AccountingPeriodName>
                  <b:AccountingPeriodUid>1152921504606866111<AccountingPeriodUid>1152921504606866568</b:AccountingPeriodUid>
                  <b:BeginDate>2018BeginDate>2017-0701-01T00:00:00</b:BeginDate>
                  <b:EndDate i:nil="true"/>:EndDate>2017-06-30T00:00:00</b:EndDate>
                  <b:OpenForAdjustmentsFlag>false</b:OpenForAdjustmentsFlag>
                  <b:OpenForApTransactionsFlag i:nil="true"/>OpenForApTransactionsFlag>true</b:OpenForApTransactionsFlag>
                  <b:OpenForArTransactionsFlag i:nil="true"/>OpenForArTransactionsFlag>true</b:OpenForArTransactionsFlag>
                  <b:OpenForCostFlag i:nil="true"/>OpenForCostFlag>true</b:OpenForCostFlag>
                  <b:OpenForGlTransactionsFlag i:nil="true"/>
OpenForGlTransactionsFlag>true</b:OpenForGlTransactionsFlag>
                 <b:OpenForTimeFlag i:nil="true"/><b:OpenForTimeFlag>true</b:OpenForTimeFlag>
               </b:PwsAccountingPeriodSummary>
               <b:PwsAccountingPeriodSummary>
                  <b:AccountingPeriodCode>AccountingPeriodCode>07~12-062018<2016</b:AccountingPeriodCode>
                  <b:AccountingPeriodId i:nil="true"/>
                  <b:AccountingPeriodName>TillAccountingPeriodName>Jul-Jun2018<Dec2016</b:AccountingPeriodName>
                  <b:AccountingPeriodUid>1152921504606863107<AccountingPeriodUid>1152921504606866567</b:AccountingPeriodUid>
                  <b:BeginDate>2015BeginDate>2016-07-01T00:00:00</b:BeginDate>
                  <b:EndDate>2018EndDate>2016-0612-30T0031T00:00:00</b:EndDate>
                  <b:OpenForAdjustmentsFlag>true<OpenForAdjustmentsFlag>false</b:OpenForAdjustmentsFlag>
                  <b:OpenForApTransactionsFlag i:nil="true"/>OpenForApTransactionsFlag>false</b:OpenForApTransactionsFlag>
                  <b:OpenForArTransactionsFlag i:nil="true"/>
OpenForArTransactionsFlag>false</b:OpenForArTransactionsFlag>
                 <b:OpenForCostFlag i:nil="true"/><b:OpenForCostFlag>false</b:OpenForCostFlag>
                  <b:OpenForGlTransactionsFlag i:nil="true"/>OpenForGlTransactionsFlag>true</b:OpenForGlTransactionsFlag>
                  <b:OpenForTimeFlag i:nil="true"/>OpenForTimeFlag>false</b:OpenForTimeFlag>
               </b:PwsAccountingPeriodSummary>
               <b:PwsAccountingPeriodSummary>
                  <b:AccountingPeriodCode>04AccountingPeriodCode>01~06-062015<2016</b:AccountingPeriodCode>
                  <b:AccountingPeriodId i:nil="true"/>
                  <b:AccountingPeriodName>AprAccountingPeriodName>Jan-Jun2015<Jun2016</b:AccountingPeriodName>
                  <b:AccountingPeriodUid>1152921504606862364<AccountingPeriodUid>1152921504606866111</b:AccountingPeriodUid>
                  <b:BeginDate>2015BeginDate>2016-0401-01T00:00:00</b:BeginDate>
                  <b:EndDate>2015EndDate>2016-06-30T00:00:00</b:EndDate>
                  <b:OpenForAdjustmentsFlag>true</b:OpenForAdjustmentsFlag>
                  <b:OpenForApTransactionsFlag i:nil="true"/>:OpenForApTransactionsFlag>true</b:OpenForApTransactionsFlag>
                  <b:OpenForArTransactionsFlag i:nil="true"/>OpenForArTransactionsFlag>false</b:OpenForArTransactionsFlag>
                  <b:OpenForCostFlag i:nil="true"/>OpenForCostFlag>true</b:OpenForCostFlag>
                  <b:OpenForGlTransactionsFlag i:nil="true"/>OpenForGlTransactionsFlag>true</b:OpenForGlTransactionsFlag>
                  <b:OpenForTimeFlag i:nil="true"/>OpenForTimeFlag>true</b:OpenForTimeFlag>
               </b:PwsAccountingPeriodSummary>
            </a:AccountingPeriods>
         </PwsGetAccountingPeriodListResult>
      </PwsGetAccountingPeriodListResponse>
   </s:Body>
</s:Envelope>

...

Code Block

language	xml
title	Example 02 - Accounting period is specified
collapse	true

<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.

Versions Compared

Old Version 11

New Version Current

Key

Request Format

Request Format

Usage Example(s)

Usage Example(s)

Response Format

Response Elements

Usage Example(s)

Response Format

Response Elements

Usage Example(s)

PwsGetAccountingPeriodList - Common Errors and Warnings

Page Comparison

Versions Compared

Old Version 11

New Version Current

Key

Request Format

Request Format

Usage Example(s)

Usage Example(s)

Response Format

Response Elements

Usage Example(s)

Response Format

Response Elements

Usage Example(s)

PwsGetAccountingPeriodList - Common Errors and Warnings