GLData_Retrieve API

2 Minutes to read

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Retrieves the collection of GLData objects that meet the filter criteria supplied. Each GLData object returned corresponds to a row of GL Data in the database.

Syntax

GLData = api.GLData _Retrieve (GLDataFilter FilterCriteria)

Usage

Use the GLData_Retrieve call to retrieve GLData data. When a Client application invokes the GLData_Retrieve call, it passes in the GLData filter criteria in collection of GLDataFilter objects to filter the data rows.

Upon invocation, the Web Service queries the database for GLData data rows with the specified filter criteria and returns the collection of GLData objects. Each GLData object corresponds to a data row in the database.

The Client application can then use methods on the collection of GLData objects to iterate through the collection and retrieve information.

The Client application must be logged in with sufficient access rights to query GLData objects.

Arguments List

The following table provides a list of arguments that are required for the GLData_Retrieve method call:

Name	Type	Description
GLDataFilter	GLDataFilter()	Collection of segment filter objects to filter the GL Data rows during retrieval.

Notes:

Fields on which filter can be applied: Segment1, Segment2, Segment3, Segment4, Segment5, Segment6, Segment7, Segment8, Scenario, Reporting, FiscalYear, FiscalPeriod, AmountType.
Mandatory filter fields: Scenario, AmountType, and FiscalYear (NOTE: FiscalYear is mandatory if scenario is Actual or filter fields contain FiscalPeriod)
Field operators supported: Equals, Contains
Multiple filters can be applied on one retrieval but only one value can be supplied per field. For instance, to retrieve the data for two scenarios Actual and Budget, the API needs to be called two times once for Actual and once for Budget scenario.

Response

The GLData_Retrieve method call returns collection of GLData objects, which contain the data values of GLData data rows in the database.

Sample Code

<ns:GLData_RetrieveWithLogin>
	<ns:LoginName>mborra@planful.com</ns:LoginName>
	<ns:Password>VASavi@61</ns:Password>
	<ns:TenantCode>ETLCPMTENANTBASEQFQACopy</ns:TenantCode>
	<ns:FilterCollection>
		<ns:GLDataFilter>
		<ns:Field>FiscalYear</ns:Field>
		<ns:FieldOperator>Equals</ns:FieldOperator>
		<ns:Value>
			<ns:string>2012</ns:string>
		</ns:Value>
		</ns:GLDataFilter>
		<ns:GLDataFilter>
		<ns:Field>FiscalPeriod</ns:Field>
		<ns:FieldOperator>Equals</ns:FieldOperator>
		<ns:Value>
			<ns:string>4</ns:string>
		</ns:Value>
		</ns:GLDataFilter>
		<ns:GLDataFilter>
		<ns:Field>Segment2</ns:Field>
		<ns:FieldOperator>Equals</ns:FieldOperator>
		<ns:Value>
			<ns:string>112ETL</ns:string>
		</ns:Value>
		</ns:GLDataFilter>
		<ns:GLDataFilter>
		<ns:Field>Scenario</ns:Field>
		<ns:FieldOperator>Equals</ns:FieldOperator>
		<ns:Value>
			<ns:string>Forecast2012</ns:string>
		</ns:Value>
		</ns:GLDataFilter>
		<ns:GLDataFilter>
		<ns:Field>AmountType</ns:Field>
		<ns:FieldOperator>Equals</ns:FieldOperator>
		<ns:Value>
			<ns:string>MTD</ns:string>
		</ns:Value>
		</ns:GLDataFilter>
	</ns:FilterCollection>
	<ns:ApplyCreditDebit>No</ns:ApplyCreditDebit>
</ns:GLData_RetrieveWithLogin>

Output

<GLData_RetrieveWithLoginResponse xmlns="http://www.Planful.com/API/SOAP/StateFree/Common/2009/03/19">
	<GLData_RetrieveWithLoginResult>
	<GLData>
		<Segment1>Flow-MTD-Credit</Segment1>
		<Segment2>112ETL</Segment2>
		<Segment3>000</Segment3>
		<Segment4>00</Segment4>
		<Segment5>1000</Segment5>
		<Segment6>000</Segment6>
		<Segment7>00</Segment7>
		<Segment8>000-0000</Segment8>
		<Scenario>Forecast2012</Scenario>
		<Reporting>G/L Data (LC)</Reporting>
		<Amount>40.000000</Amount>
		<AmountType>MTD</AmountType>
		<FiscalYear>2012</FiscalYear>
		<FiscalPeriod>4</FiscalPeriod>
	</GLData>
	<GLData>
		<Segment1>Flow-MTD-Credit</Segment1>
		<Segment2>112ETL</Segment2>
		<Segment3>000</Segment3>
		<Segment4>00</Segment4>
		<Segment5>1000</Segment5>
		<Segment6>000</Segment6>
		<Segment7>00</Segment7>
		<Segment8>000-0000</Segment8>
		<Scenario>Forecast2012</Scenario>
		<Reporting>Currency (LC to CC)</Reporting>
		<Amount>80.000000</Amount>
		<AmountType>MTD</AmountType>
		<FiscalYear>2012</FiscalYear>
		<FiscalPeriod>4</FiscalPeriod>
	</GLData>
	<GLData>
		<Segment1>Balance-YTD-Debit</Segment1>
		<Segment2>112ETL</Segment2>
		<Segment3>000</Segment3>
		<Segment4>00</Segment4>
		<Segment5>1000</Segment5>
		<Segment6>000</Segment6>
		<Segment7>00</Segment7>
		<Segment8>000-0000</Segment8>
		<Scenario>Forecast2012</Scenario>
		<Reporting>G/L Data (LC)</Reporting>
		<Amount>40.000000</Amount>
		<AmountType>MTD</AmountType>
		<FiscalYear>2012</FiscalYear>
		<FiscalPeriod>4</FiscalPeriod>
	</GLData>
	<GLData>
		<Segment1>Balance-YTD-Debit</Segment1>
		<Segment2>112ETL</Segment2>
		<Segment3>000</Segment3>
		<Segment4>00</Segment4>
		<Segment5>1000</Segment5>
		<Segment6>000</Segment6>
		<Segment7>00</Segment7>
		<Segment8>000-0000</Segment8>
		<Scenario>Forecast2012</Scenario>
		<Reporting>Currency (LC to CC)</Reporting>
		<Amount>80.000000</Amount>
		<AmountType>MTD</AmountType>
		<FiscalYear>2012</FiscalYear>
		<FiscalPeriod>4</FiscalPeriod>
	</GLData>
	</GLData_RetrieveWithLoginResult>
</GLData_RetrieveWithLoginResponse>

Sample Invalid Input

<ns:GLData_RetrieveWithLogin>
	<ns:LoginName>mborra@planful.com</ns:LoginName>
	<ns:Password>VASavi@61</ns:Password>
	<ns:TenantCode>ETLCPMTENANTBASEQFQACopy</ns:TenantCode>
	<ns:FilterCollection>
	<ns:GLDataFilter>
		<ns:Field>Scenario</ns:Field>
		<ns:FieldOperator>Equals</ns:FieldOperator>
		<ns:Value>
			<ns:string>DummyScenario</ns:string>
		</ns:Value>
	</ns:GLDataFilter>
	<ns:GLDataFilter>
		<ns:Field>AmountType</ns:Field>
		<ns:FieldOperator>Equals</ns:FieldOperator>
		<ns:Value>
			<ns:string>MTD</ns:string>
		</ns:Value>
	</ns:GLDataFilter>
	</ns:FilterCollection>
</ns:GLData_RetrieveWithLogin>

Invalid Output

<faultstring>Scenario code is not valid</faultstring>

Was this article helpful?

GLData_Retrieve API

What's Next