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

# Getboxkite Boxkite Agent API

The Boxkite Agent API produces a read-only export of a user's Xero accounting data as a downloadable ZIP with a manifest and a file-to-object mapping. An agent lists the connected Xero organisations, starts an export for one of them, and polls it to completion, then reads the manifest describing every file and the mapping that ties each file to its Xero object, such as which invoice a receipt belongs to. A signed download URL serves the ZIP during a retention window. Boxkite requests only read-only Xero scopes, so an export cannot modify the user's books, and starting an export returns a checkout URL for a one-off payment per organisation. Responses are JSON.

## For AI agents

Start a read-only export of a Xero organisation's books, poll it to completion, read its manifest and file-to-object mapping, and fetch a signed URL to the export ZIP. Authenticates with a bearer API key.

## Scope

Does not modify Xero data, manage invoices, or run payroll. Use for read-only export of Xero organisation data only.

## Capabilities

- Start a read-only export of a Xero organisation's data
- List the Xero organisations connected to the account
- Poll an export's status and progress until it is ready
- Read the manifest describing every file in an export
- Read the mapping from each exported file to its Xero object
- Get a short-lived signed URL to download the export ZIP

## Use cases

### Agent-Driven Xero Export

An AI agent that needs a copy of a user's Xero data can call the Boxkite Agent API through Jentic to start a read-only export, poll it until it is ready, and fetch a signed download URL for the ZIP. The agent runs the export without the developer wiring the bearer auth or the status polling by hand, and because Boxkite requests only read-only scopes the export cannot change the books. Jentic returns the matching operation and its input schema so the agent runs the export inline.

Example prompt: Start an export for a connected Xero organisation, poll it until ready, and fetch the signed download URL

### Accounting Data Archive

A firm that wants an off-platform archive of its books can export each connected organisation on a schedule and store the ZIP elsewhere. Boxkite produces the export as a ZIP with a manifest and holds a signed download URL during a retention window, so a workflow can archive a point-in-time copy of the accounting data without modifying anything in Xero.

Example prompt: Export every connected organisation, download each ZIP, and store it in an external archive

### File-to-Object Reconciliation

A workflow reconciling documents can use the export's mapping to tie each file to the Xero object it represents or is attached to, such as which invoice a receipt PDF belongs to. Boxkite returns a file-to-object mapping alongside the manifest, so an agent can match exported files to their accounting records without opening each one.

Example prompt: Read an export's mapping and list the invoice each exported receipt file is attached to

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/exports` | Start a read-only export |
| GET | `/exports` | List exports and poll status |
| GET | `/exports/{id}` | Get export status and progress |
| GET | `/exports/{id}/manifest` | Get the export manifest |
| GET | `/exports/{id}/mapping` | Get the file-to-object mapping |
| GET | `/exports/{id}/download` | Get a signed download URL for the ZIP |
| GET | `/organisations` | List connected Xero organisations |

## Key resources

- **Organisations** — List the Xero organisations connected to the authenticated account.
- **Exports** — Start a read-only export, list exports, and poll an export's status and progress.
- **Manifest and Mapping** — Read the manifest of files in an export and the file-to-object mapping.
- **Download** — Get a short-lived signed URL to the export ZIP during its retention window.

## 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:** 64 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 44 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 70 / 100
- **View full report:** https://jentic.com/apis/getboxkite.com/getboxkite/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 Boxkite by hand means handling its bearer API key, completing the one-off Stripe checkout that start-export returns, and polling the export until its signed download URL is ready. Through Jentic you install once, import Boxkite from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Every Boxkite operation is read-only, so it cannot modify the books, and Boxkite puts the export id in the URL path so a rule can bound your agent to the export operations you pick. You choose which operations it may call, such as starting, polling, and downloading exports.
- **Credential handling:** Your Boxkite API key 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 'export a Xero organisation' or 'download an export', and Jentic returns the matching Boxkite operation with its input schema so the agent calls the right endpoint directly.

## Related APIs

- **Xero Accounting API** — The live Xero books that Boxkite exports read-only copies of.
- **Codat Accounting API** — Reads standardised accounting data across Xero and other platforms.
- **Apideck Accounting API** — Unified accounting API spanning invoices, bills, and ledger accounts.

## FAQ

### What authentication does the Boxkite Agent API use?

The Boxkite Agent API authenticates with a bearer API key on every operation, per its OpenAPI spec. Through Jentic the key is stored once, encrypted, by your own Jentic One instance and injected at call time, so it never reaches the agent's prompt or logs.

### Is there a Boxkite MCP server?

You don't need an MCP server to give your agent the Boxkite Agent API. Jentic connects it directly from the API Directory: import it, store your key once, and your agent can start and download exports straight away.

### Can I limit what my agent is allowed to do with the Boxkite Agent API?

Yes. Every Boxkite operation is read-only, so an export can never modify the books, and Boxkite puts the export id in the URL path so a rule can bound your agent to the export operations you pick. Allow it to list organisations, start and poll exports, and download them, and every call it makes is logged.

### Can I export a Xero organisation's data with the Boxkite Agent API?

Yes. The start-export operation begins a read-only export for a connected organisation and returns a checkout URL for the one-off payment, after which an agent polls the export and fetches a signed URL to download the ZIP.

### What are the rate limits for the Boxkite Agent API?

The OpenAPI spec does not publish a numeric rate limit; a completed export's download URL stays valid only during a retention window. Check the Boxkite documentation for the current limits on your plan.

### How do I export Xero data with the Boxkite Agent API through Jentic?

Search Jentic for an intent like 'export a Xero organisation's data' and it returns the Boxkite export operations with their input schemas, so your agent starts the export, polls it, and downloads the ZIP. To run it on your own infrastructure, install Jentic One from its GitHub repo.