canonical: https://jentic.com/apis/planful.com/planful

# Planful REST API

Planful financial planning and analysis API for managing budgets, forecasts, consolidations, and financial data. The API exposes 4 endpoints secured with oauth2 authentication.

## For AI agents

Programmatically import financial data, export financial data. Covers 4 operations with oauth2 authentication.

## Scope

Does not handle payments, communications, or crm - use for finance and accounting only.

## Capabilities

- Import financial data
- Export financial data
- List scenarios

## Use cases

### Finance and Accounting Operations

Use the Planful REST API to perform finance operations programmatically. The API provides 4 endpoints covering core functionality including import financial data, export financial data, list scenarios.

Example prompt: Call POST `/data/import` to import financial data

### Automated Data Management

Automate data operations by combining multiple Planful REST API endpoints. Agents can export financial data and then list scenarios in a single workflow.

Example prompt: Call POST `/data/export` to export financial data, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Planful REST API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle oauth2 tokens manually.

Example prompt: Search Jentic for 'import financial data', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/data/import` | Import financial data |
| POST | `/data/export` | Export financial data |
| GET | `/scenarios` | List scenarios |
| GET | `/dimensions` | List dimensions |

## Key resources

- **Data** — Operations related to Data
- **Metadata** — Operations related to Metadata
- **Planning** — Operations related to Planning

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 69 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 84 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 47 / 100
  - Agent Usability: 94 / 100
  - Security: 85 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/planful.com/planful/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Planful REST API by hand means setting up its OAuth token auth and hand-building the request plumbing for its data import, export, scenario and dimension calls yourself. Through Jentic you install once, import Planful from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** Planful's operations take their target in the request body rather than the URL path, so scoping is operations-only: limit the agent to the operations it needs, such as reading scenarios or dimensions. You choose which operations it may call, so ones like importing or exporting data are not included unless you add them.
- **Credential handling:** Your Planful OAuth credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'import financial data' or 'list scenarios', and Jentic returns the matching Planful operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Plaid** — Alternative finance API
- **Xero** — Alternative finance API

## FAQ

### What authentication does the Planful REST API use?

The Planful REST API uses OAuth 2.0 for authorization. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I import financial data with the Planful REST API?

Yes. Use the POST `/data/import` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Planful REST API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I import financial data through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'import financial data'. Jentic returns the matching Planful REST API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Planful REST API have?

The Planful REST API exposes 4 endpoints covering data, metadata, planning operations.

### Can I limit what my agent is allowed to do with the Planful REST API?

Yes. Because you run Jentic One yourself, you decide which Planful operations your agent may call, and your own rules govern the OAuth credential it uses. Planful takes its target in the request body rather than the URL path, so scoping is at the operation level: you can allow read-only calls such as GET /scenarios and GET /dimensions while withholding writes like POST `/data/import` and POST `/data/export.` Any operation you do not grant stays unavailable to the agent.