Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This web service retrieves a list of project summary records (PwsProjectSummaryPwsAccountingPeriodSummary), 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.
  • ProjectIdentityin accounting period code or name
  • AccountingPeriodIdentity: If specified, the identified engagement accounting period will be returned. And QueryString and IncludeClosedFlag will be ignored.

Request Format

Panel
titlePwsGetAccountingPeriodList 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



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)

Code Block
languagexml
titleExample 01 - Project is not specified
collapsetrue
</soapenv:Envelope>

...

Panel
titlePwsGetAccountingPeriodList Response

Response Elements

Element

Data Type

Description

Sample Data

Messages

PwsMessage



ResponseId

Int32

Click here for more information.


StatusRequestStatusClick here for more informationOk

ServerTimestampUtc

DateTime

Click here for more information.


AccountingPeriods

PwsAccountingPeriodSummary



Usage Example(s)

Code Block
languagexml
titleExample 01 - Project is not specified with error code
collapsetrue
</s:Envelope>

...