Utility Objects
- 1 Minute to read
- Print
- DarkLight
- PDF
Utility Objects
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
LoginResult
Loginresult object contains the status and message for the login into the API. It is a result object that is returned as a response from the API for the login request. The following table provides a list of properties for the Loginresult object.
Property Name | Property Description |
|---|---|
Message | Status message for the login method call. |
Success | Boolean value to indicate whether the login method call is a success or failure. Possible values are: True False |
SessionId | The session Id to perform data import / export operations. Used for authenticating the API method call. |
Error | Error object is returned in case of any error during the Login method call. |
OperationResult
The Operationresult object contains the status and message for the API method call. For example, Load_Data method call returns an Operation result object. The following table provides a list of properties for the Operationresult object.
Property Name | Property Description |
|---|---|
Message | Status message for the login method call. |
Success | Boolean value to indicate whether the login method call is a success or failure. Possible values are: True False |
Error | Error object is returned in case of any error during the Login method call. |
APPVersion
Appversion object contains the data values for the Planful application version. The following table provides a list of properties for the Appversion object.
Property Name | Property Description |
|---|---|
Name | The Planful application version name. |
Version | The Planful application version. |
COASegment
COASegment object contains the data values for the financial segment of the organization. The following table provides a list of properties for the COASegment object.
Property Name | Property Description |
|---|---|
Name | String |
DisplayName | String |
Type | String |
Visibility | Visibility enumeration member |
ActiveStatus | ActiveStatus enumeration member |
Currency
Currency object contains the data values for the currency data. The following table provides a list of properties for the currency object.
Property Name | Property Description |
|---|---|
Code | String |
Name | String |
CurrenctType
CurrencyType object contains data values for currency type data. The following table provides a list of properties for the currency type object.
Property Name | Property Description |
|---|---|
Code | String |
Name | String |
Was this article helpful?