sage-accounting

What this skill does

# Sage Accounting

Sage Accounting is an online accounting software designed for small businesses to manage their finances. It helps users track income and expenses, send invoices, and run reports. Accountants and business owners use it to maintain accurate financial records.

Official docs: https://developers.sage.com/accounting/

## Sage Accounting Overview

- **Contact**
- **Invoice**
  - **Invoice Line Item**
- **Bill**
  - **Bill Line Item**
- **Credit Note**
  - **Credit Note Line Item**
- **Debit Note**
  - **Debit Note Line Item**
- **Product**
- **Service**
- **Tax Rate**
- **Journal Entry**
  - **Journal Entry Line**
- **Bank Account**
- **Cash Flow**
- **Trial Balance**
- **Fixed Asset**
- **Fixed Asset Category**
- **Fixed Asset Depreciation**
- **Recurring Invoice**
- **Recurring Bill**
- **Payment**
- **Receipt**
- **Transfer**
- **User**
- **Role**
- **Address**
- **Attachment**
- **Company**
- **Reconciliation**
- **Transaction**
- **Sales Invoice**
- **Purchase Invoice**
- **Sales Credit Note**
- **Purchase Credit Note**
- **Sales Debit Note**
- **Purchase Debit Note**

Use action names and parameters as needed.

## Working with Sage Accounting

This skill uses the Membrane CLI to interact with Sage Accounting. Membrane handles authentication and credentials refresh automatically — so you can focus on the integration logic rather than auth plumbing.

### Install the CLI

Install the Membrane CLI so you can run `membrane` from the terminal:

```bash
npm install -g @membranehq/cli@latest
```

### Authentication

```bash
membrane login --tenant --clientName=<agentType>
```

This will either open a browser for authentication or print an authorization URL to the console, depending on whether interactive mode is available.

**Headless environments:** The command will print an authorization URL. Ask the user to open it in a browser. When they see a code after completing login, finish with:

```bash
membrane login complete <code>
```

Add `--json` to any command for machine-readable JSON output.

**Agent Types** : claude, openclaw, codex, warp, windsurf, etc. Those will be used to adjust tooling to be used best with your harness

### Connecting to Sage Accounting

Use `membrane connection ensure` to find or create a connection by app URL or domain:

```bash
membrane connection ensure "https://www.sage.com/en-gb/sage-business-cloud/accounting/" --json
```
The user completes authentication in the browser. The output contains the new connection id.

This is the fastest way to get a connection. The URL is normalized to a domain and matched against known apps. If no app is found, one is created and a connector is built automatically.

If the returned connection has `state: "READY"`, skip to **Step 2**.

#### 1b. Wait for the connection to be ready

If the connection is in `BUILDING` state, poll until it's ready:

```bash
npx @membranehq/cli connection get <id> --wait --json
```

The `--wait` flag long-polls (up to `--timeout` seconds, default 30) until the state changes. Keep polling until `state` is no longer `BUILDING`.

The resulting state tells you what to do next:

- **`READY`** — connection is fully set up. Skip to **Step 2**.
- **`CLIENT_ACTION_REQUIRED`** — the user or agent needs to do something. The `clientAction` object describes the required action:
  - `clientAction.type` — the kind of action needed:
    - `"connect"` — user needs to authenticate (OAuth, API key, etc.). This covers initial authentication and re-authentication for disconnected connections.
    - `"provide-input"` — more information is needed (e.g. which app to connect to).
  - `clientAction.description` — human-readable explanation of what's needed.
  - `clientAction.uiUrl` (optional) — URL to a pre-built UI where the user can complete the action. Show this to the user when present.
  - `clientAction.agentInstructions` (optional) — instructions for the AI agent on how to proceed programmatically.

  After the user completes the action (e.g. authenticates in the browser), poll again with `membrane connection get <id> --json` to check if the state moved to `READY`.

- **`CONFIGURATION_ERROR`** or **`SETUP_FAILED`** — something went wrong. Check the `error` field for details.

### Searching for actions

Search using a natural language description of what you want to do:

```bash
membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json
```

You should always search for actions in the context of a specific connection.

Each result includes `id`, `name`, `description`, `inputSchema` (what parameters the action accepts), and `outputSchema` (what it returns).

## Popular actions

| Name | Key | Description |
|---|---|---|
| List Sales Invoices | list-sales-invoices | Retrieves a list of sales invoices from Sage Accounting |
| List Purchase Invoices | list-purchase-invoices | Retrieves a list of purchase invoices (bills) from Sage Accounting |
| List Contacts | list-contacts | Retrieves a list of contacts (customers and suppliers) from Sage Accounting |
| List Products | list-products | Retrieves a list of products from Sage Accounting |
| List Journal Entries | list-journal-entries | Retrieves a list of journal entries from Sage Accounting |
| List Bank Accounts | list-bank-accounts | Retrieves a list of bank accounts from Sage Accounting |
| List Ledger Accounts | list-ledger-accounts | Retrieves a list of ledger accounts (chart of accounts) from Sage Accounting |
| List Contact Payments | list-contact-payments | Retrieves a list of contact payments (customer receipts) from Sage Accounting |
| List Sales Credit Notes | list-sales-credit-notes | Retrieves a list of sales credit notes from Sage Accounting |
| Get Sales Invoice | get-sales-invoice | Retrieves a specific sales invoice by ID from Sage Accounting |
| Get Purchase Invoice | get-purchase-invoice | Retrieves a specific purchase invoice by ID from Sage Accounting |
| Get Contact | get-contact | Retrieves a specific contact by ID from Sage Accounting |
| Get Product | get-product | Retrieves a specific product by ID from Sage Accounting |
| Get Journal Entry | get-journal-entry | Retrieves a specific journal entry by ID from Sage Accounting |
| Get Bank Account | get-bank-account | Retrieves a specific bank account by ID from Sage Accounting |
| Create Sales Invoice | create-sales-invoice | Creates a new sales invoice in Sage Accounting |
| Create Purchase Invoice | create-purchase-invoice | Creates a new purchase invoice (bill) in Sage Accounting |
| Create Contact | create-contact | Creates a new contact (customer or supplier) in Sage Accounting |
| Create Product | create-product | Creates a new product in Sage Accounting |
| Update Contact | update-contact | Updates an existing contact in Sage Accounting |

### Running actions

```bash
membrane action run <actionId> --connectionId=CONNECTION_ID --json
```

To pass JSON parameters:

```bash
membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "value"}' --json
```

The result is in the `output` field of the response.


### Proxy requests

When the available actions don't cover your use case, you can send requests directly to the Sage Accounting API through Membrane's proxy. Membrane automatically appends the base URL to the path you provide and injects the correct authentication headers — including transparent credential refresh if they expire.

```bash
membrane request CONNECTION_ID /path/to/endpoint
```

Common options:

| Flag | Description |
|------|-------------|
| `-X, --method` | HTTP method (GET, POST, PUT, PATCH, DELETE). Defaults to GET |
| `-H, --header` | Add a request header (repeatable), e.g. `-H "Accept: application/json"` |
| `-d, --data` | Request body (string) |
| `--json` | Shorthand to send a JSON body and set `Content-Type: application/json` |
| `--rawData` | Send the body as-is without any processing |
| `--query` | Query-string parameter (repeatable), e.g. `--query "limit=10"` |
| `--pathPa