API Calls - Overview

1 Minute to read

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

API calls represent specific operations that your Client applications can invoke at runtime to perform certain tasks. For example, you can: query your organization’s data; load COA segment / GL data; obtain metadata about your organization’s data; and run utilities to perform administration tasks.

API calls are categorized into two types:

Core calls - Used to perform data import or data export operations on COA segments and GL data.
Utility calls - Used to perform utility functions such as logging into the application, retrieving current user session details, and retrieving current application version.

Core Calls

The following provides a list of API core calls:

Name	Description
Load_Data	Loads the COA Segment/GL data to Planful staging area
Transfer_Data	Transfers the staging data to the destination table.
Clear_Data	Clears the staging data in Planful.
Segment1_Retrieve	Retrieves the collection of segment1 objects that correspond to segment1 data rows in the database.
Segment2_Retrieve	Retrieves the collection of segment2 objects that correspond to segment2 data rows in the database.
Segment3_Retrieve	Retrieves the collection of segment3 objects that correspond to segment3 data rows in the database.
Segment4_Retrieve	Retrieves the collection of segment4 objects that correspond to segment4 data rows in the database.
Segment5_Retrieve	Retrieves the collection of segment5 objects that correspond to segment5 data rows in the database.
Segment6_Retrieve	Retrieves the collection of segment6 objects that correspond to segment6 data rows in the database.
Segment7_Retrieve	Retrieves the collection of segment7 objects that correspond to segment7 data rows in the database.
Segment8_Retrieve	Retrieves the collection of segment8 objects that correspond to segment8 data rows in the database.
GLData_Retrieve	Retrieves the collection of GLData objects that correspond to GL data rows in the database.

Utility Calls

The following table provides a list of API utility calls:

Name	Description
Login	Logs into the Planful Web Service application to perform data import/export operations.
getSessionId	Retrieves the current user session details like session ID.
getVersion	Retrieves the current version of the Planful application.
getAllSegments	Retrieves the collection of Financial segments for the organization as configured in the Planful application.
getAllCurrencies	Retrieves the collection of currency objects that correspond to currency data rows in the database.
getAllCurrencyTypes	Retrieves the collection of currency type objects that correspond to currency type data rows in the database.

Was this article helpful?

What's Next

Objects

Table of contents