Overview
This web service retrieves a list of project summary records (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.
Request Format
| Panel | ||
|---|---|---|
| ||
|
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 | |||||
IncludeFullyClosedFlag | Boolean | ||||
IncludeOpenForAdjustmentsFlag | Boolean | ||||
IncludeOpenForApTransactionsFlag | Boolean | ||||
IncludeOpenForArTransactionsFlag | Boolean | ||||
IncludeOpenForCostFlag | Boolean | ||||
IncludeOpenForGlTransactionsFlag | Boolean | ||||
IncludeOpenForTimeFlag | Boolean | ||||
MaxRowsToReturn | Int32 | ||||
QueryString | String | ||||
CompanyIdentity |
Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
</soapenv:Envelope> |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
</soapenv:Envelope> |
Response Format
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | |||
ResponseId | Int32 | Click here for more information. | |
| Status | RequestStatus | Click here for more information | Ok |
ServerTimestampUtc | DateTime | Click here for more information. | |
AccountingPeriods |
Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
</s:Envelope> |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
</s:Envelope> |
Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | Description |
|---|---|---|