...
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 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 | false | 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 | false | 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 | false | 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 | false | 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 | false | 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 | No | The identity of the company whose accounting periods are being retrieved. Click here for more information. |
...
| 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:IncludeFullyClosedFlag>true<IncludeOpenForAdjustmentsFlag>false</req:IncludeFullyClosedFlag>
<req:IncludeOpenForAdjustmentsFlag>true</req:IncludeOpenForAdjustmentsFlag>
<req:IncludeOpenForApTransactionsFlag>true</req:IncludeOpenForApTransactionsFlag>
<req:IncludeOpenForArTransactionsFlag>true<IncludeOpenForArTransactionsFlag>false</req:IncludeOpenForArTransactionsFlag>
<req:IncludeOpenForCostFlag>true</req:IncludeOpenForCostFlag>
<req:IncludeOpenForGlTransactionsFlag>true</req:IncludeOpenForGlTransactionsFlag>
<req:IncludeOpenForTimeFlag>true</req:IncludeOpenForTimeFlag>
<req:MaxRowsToReturn>3<MaxRowsToReturn>5</req:MaxRowsToReturn>
<req:QueryString></req:QueryString>CompanyIdentity>
</pws:serviceRequest> </pws:PwsGetAccountingPeriodList><com:CompanyName>Revolutionary Solutions Corporation CA</com:CompanyName>
</soapenv:Body>
</ </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> |
...
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/">
<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-13T1915T15:4203:2237.6252189Z<4306662Z</ServerTimestampUtc>
<a:AccountingPeriods xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:PwsAccountingPeriodSummary>
<b:AccountingPeriodCode>future<AccountingPeriodCode>01~06-2018</b:AccountingPeriodCode>
<b:AccountingPeriodId i:nil="true"/>
<b:AccountingPeriodName>future<AccountingPeriodName>Jan-Jun2018</b:AccountingPeriodName>
<b:AccountingPeriodUid>1152921504606866111<AccountingPeriodUid>1152921504606866570</b:AccountingPeriodUid>
<b:BeginDate>2018-0701-01T00:00:00</b:BeginDate>
<b:EndDate i:nil="true"/>EndDate>2018-06-30T00:00:00</b:EndDate>
<b:OpenForAdjustmentsFlag>false<OpenForAdjustmentsFlag>true</b:OpenForAdjustmentsFlag>
<b:OpenForApTransactionsFlag>true</b:OpenForApTransactionsFlag i:nil="true"/>
OpenForApTransactionsFlag>
<b:OpenForArTransactionsFlag i:nil="true"/>OpenForArTransactionsFlag>false</b:OpenForArTransactionsFlag>
<b:OpenForCostFlag i:nil="true"/>OpenForCostFlag>false</b:OpenForCostFlag>
<b:OpenForGlTransactionsFlag i:nil="true"/>OpenForGlTransactionsFlag>false</b:OpenForGlTransactionsFlag>
<b:OpenForTimeFlag i:nil="true"/>OpenForTimeFlag>false</b:OpenForTimeFlag>
</b:PwsAccountingPeriodSummary>
<b:PwsAccountingPeriodSummary>
<b:AccountingPeriodCode>AccountingPeriodCode>07~12-062018<2017</b:AccountingPeriodCode>
<b:AccountingPeriodId i:nil="true"/>
<b:AccountingPeriodName>TillAccountingPeriodName>Jul-Jun2018<Dec2017</b:AccountingPeriodName>
<b:AccountingPeriodUid>1152921504606863107<AccountingPeriodUid>1152921504606866569</b:AccountingPeriodUid>
<b:BeginDate>2015BeginDate>2017-07-01T00:00:00</b:BeginDate>
<b:EndDate>2018EndDate>2017-0612-30T0031T00:00:00</b:EndDate>
<b:OpenForAdjustmentsFlag>true</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>false</b:OpenForCostFlag>
<b:OpenForGlTransactionsFlag>true</b:OpenForGlTransactionsFlag i:nil="true"/>
OpenForGlTransactionsFlag>
<b:OpenForTimeFlag i:nil="true"/>OpenForTimeFlag>true</b:OpenForTimeFlag>
</b:PwsAccountingPeriodSummary>
<b:PwsAccountingPeriodSummary>
<b:AccountingPeriodCode>04AccountingPeriodCode>01~06-062015<2017</b:AccountingPeriodCode>
<b:AccountingPeriodId i:nil="true"/>
<b:AccountingPeriodName>AprAccountingPeriodName>Jan-Jun2015<Jun2017</b:AccountingPeriodName>
<b:AccountingPeriodUid>1152921504606862364<AccountingPeriodUid>1152921504606866568</b:AccountingPeriodUid>
<b:BeginDate>2015BeginDate>2017-0401-01T00:00:00</b:BeginDate>
<b:EndDate>2015EndDate>2017-06-30T00:00:00</b:EndDate>
<b:OpenForAdjustmentsFlag>true<OpenForAdjustmentsFlag>false</b:OpenForAdjustmentsFlag>
<b:OpenForApTransactionsFlag i:nil="true"/>OpenForApTransactionsFlag>true</b:OpenForApTransactionsFlag>
<b:OpenForArTransactionsFlag i:nil="true"/>: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:OpenForCostFlag i:nil="true"/>OpenForArTransactionsFlag>false</b:OpenForArTransactionsFlag>
<b: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> |
...