Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

Overview

This web service retrieves a list of accounting period summaries (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.

This request has seven flag filters that decide which accounting periods to be included. five of the flags applies to operations that are company based and they are

  • IncludeFullyClosedFlag
  • IncludeOpenForApTransactionsFlag
  • IncludeOpenForArTransactionsFlag
  • IncludeOpenForCostFlag
  • IncludeOpenForGlTransactionsFlag
  • IncludeOpenForTimeFlag

If CompanyIdentity is omitted, these five filters are ignored.  And another one IncludeFullyClosedFlag only applies to time/Cost adjustment operation which is not company based. 

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

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 accounting period to be retrieved. Click here for more information.


IncludeFullyClosedFlag

Boolean

No

false

If a CompanyIdentity is omitted, this flag only applies to the time/cost adjustment operation. Otherwise if set to 'true', accounting periods that are closed for all operations for the specified company are included in the response. The operations include time entry, cost entry, time/cost adjustment, GL transactions, AP transactions and AR transactions.

false

IncludeOpenForAdjustmentsFlag

Boolean

No

false

If set to 'true', the accounting period that is open time/cost adjustment is included in the response. This filter is not company based.

false

IncludeOpenForApTransactionsFlag

Boolean

No


If a CompanyIdentity is omitted, this flag is ignored. Otherwise if set to 'true', accounting periods that are open for AP transactions is included in the response.

false

IncludeOpenForArTransactionsFlag

Boolean

No


If a CompanyIdentity is omitted, this flag is ignored. Otherwise if set to 'true', accounting periods that are open for AR transactions is included in the response.

false

IncludeOpenForCostFlag

Boolean

No


If a CompanyIdentity is omitted, this flag is ignored. Otherwise if set to 'true', accounting periods that are open for cost entry is included in the response.

false

IncludeOpenForGlTransactionsFlag

Boolean

No


If a CompanyIdentity is omitted, this flag is ignored. Otherwise if set to 'true', accounting periods that are open for GL transactions is included in the response.

false

IncludeOpenForTimeFlag

Boolean

No


If a CompanyIdentity is omitted, this flag is ignored. Otherwise if set to 'true', accounting periods that are open for time entry is 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. This value is disregarded if an accounting period is specified in AccountingPeriodIdentity.

Rev

CompanyIdentity

PwsCompanyRef

No


The identity of the company whose accounting periods are being retrieved. Click here for more information.


Usage Example(s)

Example 01 - Accounting period is not 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: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>3</req:MaxRowsToReturn>
            <req:QueryString></req:QueryString>
         </pws:serviceRequest>
      </pws:PwsGetAccountingPeriodList>
   </soapenv:Body>
</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>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

PwsGetAccountingPeriodList Response

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

StatusRequestStatusClick here for more informationOk

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)

Example 01 - Accounting period is not specified 
<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/">
               <b:PwsMessage>
                  <b:AdditionalErrorText>Warning 104: {oldestSurvivingTimeCardWorkDateString}</b:AdditionalErrorText>
                  <b:ErrorCode>RowCountExceeded</b:ErrorCode>
                  <b:ErrorNumber>104</b:ErrorNumber>
                  <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>
                  <b:Type>Warning</b:Type>
               </b:PwsMessage>
            </Messages>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-13T19:42:22.6252189Z</ServerTimestampUtc>
            <a:AccountingPeriods xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsAccountingPeriodSummary>
                  <b:AccountingPeriodCode>future</b:AccountingPeriodCode>
                  <b:AccountingPeriodId i:nil="true"/>
                  <b:AccountingPeriodName>future</b:AccountingPeriodName>
                  <b:AccountingPeriodUid>1152921504606866111</b:AccountingPeriodUid>
                  <b:BeginDate>2018-07-01T00:00:00</b:BeginDate>
                  <b:EndDate i:nil="true"/>
                  <b:OpenForAdjustmentsFlag>false</b:OpenForAdjustmentsFlag>
                  <b:OpenForApTransactionsFlag i:nil="true"/>
                  <b:OpenForArTransactionsFlag i:nil="true"/>
                  <b:OpenForCostFlag i:nil="true"/>
                  <b:OpenForGlTransactionsFlag i:nil="true"/>
                  <b:OpenForTimeFlag i:nil="true"/>
               </b:PwsAccountingPeriodSummary>
               <b:PwsAccountingPeriodSummary>
                  <b:AccountingPeriodCode>-062018</b:AccountingPeriodCode>
                  <b:AccountingPeriodId i:nil="true"/>
                  <b:AccountingPeriodName>Till-Jun2018</b:AccountingPeriodName>
                  <b:AccountingPeriodUid>1152921504606863107</b:AccountingPeriodUid>
                  <b:BeginDate>2015-07-01T00:00:00</b:BeginDate>
                  <b:EndDate>2018-06-30T00:00:00</b:EndDate>
                  <b:OpenForAdjustmentsFlag>true</b:OpenForAdjustmentsFlag>
                  <b:OpenForApTransactionsFlag i:nil="true"/>
                  <b:OpenForArTransactionsFlag i:nil="true"/>
                  <b:OpenForCostFlag i:nil="true"/>
                  <b:OpenForGlTransactionsFlag i:nil="true"/>
                  <b:OpenForTimeFlag i:nil="true"/>
               </b:PwsAccountingPeriodSummary>
               <b:PwsAccountingPeriodSummary>
                  <b:AccountingPeriodCode>04-062015</b:AccountingPeriodCode>
                  <b:AccountingPeriodId i:nil="true"/>
                  <b:AccountingPeriodName>Apr-Jun2015</b:AccountingPeriodName>
                  <b:AccountingPeriodUid>1152921504606862364</b:AccountingPeriodUid>
                  <b:BeginDate>2015-04-01T00:00:00</b:BeginDate>
                  <b:EndDate>2015-06-30T00:00:00</b:EndDate>
                  <b:OpenForAdjustmentsFlag>true</b:OpenForAdjustmentsFlag>
                  <b:OpenForApTransactionsFlag i:nil="true"/>
                  <b:OpenForArTransactionsFlag i:nil="true"/>
                  <b:OpenForCostFlag i:nil="true"/>
                  <b:OpenForGlTransactionsFlag i:nil="true"/>
                  <b:OpenForTimeFlag i:nil="true"/>
               </b:PwsAccountingPeriodSummary>
            </a:AccountingPeriods>
         </PwsGetAccountingPeriodListResult>
      </PwsGetAccountingPeriodListResponse>
   </s:Body>
</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

ErrorNumber

ErrorCode

Description

57335AccountingPeriodNotFoundThe specified accounting period was not found.
57339CompanyNotFoundThe specified company was not found.
  • No labels