@officedesk/plugin-xero 0.0.2 → 0.0.4

package/README.md

@@ -1,66 +1,137 @@
-# plugin-xero
+# @officedesk/plugin-xero
 
-Xero accounting integration for OfficeDesk AI.
+Xero accounting integration plugin for [OfficeDesk AI](https://github.com/initdsg/officedesk.ai). Manages contacts, invoices, bills, accounts, bank transactions, and reconciliation via the Xero API.
+
+## Installation
+
+```bash
+npm install -g @officedesk/plugin-xero
+```
 
 ## Setup
 
-Sign in to Xero with the plugin OAuth flow first:
+Sign in to Xero via the browser OAuth flow:
+
+```bash
+officedesk-plugin-xero login
+```
+
+If you need exact statement-line reconciliation, also capture the browser-authenticated Xero session:
 
 ```bash
-pnpm xero:login
+officedesk-plugin-xero browser-login
 ```
 
-If you need exact statement-line reconciliation, also capture the browser-authenticated Xero session that the bank reconciliation API expects:
+If Playwright is installed but Chromium is missing:
 
 ```bash
-pnpm xero:browser-login
+npx playwright install chromium
+```
+
+## CLI reference
+
+```
+officedesk-plugin-xero <command> [options]
 ```
 
-If Playwright is installed but Chromium is missing, install it with:
+### `login`
+
+Authenticate with Xero via the browser OAuth flow.
 
 ```bash
-pnpm --filter @officedesk/plugin-xero exec playwright install chromium
+officedesk-plugin-xero login
 ```
 
-## Statement line discovery
+### `browser-login`
+
+Capture a browser-authenticated Xero session for bank reconciliation.
 
-The compiled plugin binary now supports `get-bank-statement-lines`, which returns imported bank statement lines together with `statementLineId`, `bankStatementId`, and `bankAccountId` values.
+```bash
+officedesk-plugin-xero browser-login
+```
 
-Repo root wrapper:
+### `get-accounts`
 
 ```bash
-pnpm xero:get-bank-statement-lines -- --bankAccountId=<BANK_ACCOUNT_ID>
+officedesk-plugin-xero get-accounts
 ```
 
-Compiled binary form:
+### `get-contacts` / `get-contact` / `create-contact` / `update-contact`
 
 ```bash
-officedesk plugin-xero get-bank-statement-lines --bankAccountId=<BANK_ACCOUNT_ID>
+officedesk-plugin-xero get-contacts
+officedesk-plugin-xero get-contact --id=CONTACT_ID
+officedesk-plugin-xero create-contact --name="Acme Ltd" --email="ops@acme.com"
+officedesk-plugin-xero update-contact --id=CONTACT_ID --name="Acme Pte Ltd"
 ```
 
-Supported options:
+### `get-tax-rates`
 
-- `--bankAccountId=ID`
-- `--tenantId=ID`
-- `--status=STATUS` defaults to `unreconciled`
-- `--limit=N` defaults to `50`
-- `--offset=N` defaults to `0`
-- `--output=PATH` to override the cache output path
+```bash
+officedesk-plugin-xero get-tax-rates
+```
 
-The CLI writes structured JSON to `stdout` and stores the fetched payload in the plugin cache by default.
+### `get-branding-themes`
 
-After you capture the browser session once, `get-bank-statement-lines` reuses the saved Xero auth data directly and does not need to launch a Playwright browser for each fetch.
+```bash
+officedesk-plugin-xero get-branding-themes
+```
 
-## Exact reconciliation flow
+### `draft-invoice` / `update-invoice` / `authorise-invoice` / `send-invoice` / `delete-invoice`
 
-1. Create or identify the bank transaction you want to reconcile.
-2. List imported statement lines and find the matching `statementLineId` and `bankStatementId`.
-3. Reconcile against that exact line.
+```bash
+officedesk-plugin-xero draft-invoice --contact-id=CONTACT_ID --amount=150.00
+officedesk-plugin-xero update-invoice --id=INVOICE_ID --amount=200.00
+officedesk-plugin-xero authorise-invoice --id=INVOICE_ID
+officedesk-plugin-xero send-invoice --id=INVOICE_ID
+officedesk-plugin-xero delete-invoice --id=INVOICE_ID
+```
 
-Example:
+### `list-invoice-attachments` / `download-invoice-pdf` / `download-invoice-attachment`
 
 ```bash
-officedesk plugin-xero reconcile \
+officedesk-plugin-xero list-invoice-attachments --id=INVOICE_ID
+officedesk-plugin-xero download-invoice-pdf --id=INVOICE_ID
+officedesk-plugin-xero download-invoice-attachment --id=INVOICE_ID --attachment-id=ATTACHMENT_ID
+```
+
+### `draft-bill` / `get-bills` / `update-bill` / `submit-bill` / `authorise-bill` / `pay-bill` / `void-bill` / `delete-bill` / `attach-to-bill`
+
+```bash
+officedesk-plugin-xero get-bills
+officedesk-plugin-xero draft-bill --contact-id=CONTACT_ID --amount=500.00
+officedesk-plugin-xero authorise-bill --id=BILL_ID
+officedesk-plugin-xero pay-bill --id=BILL_ID --account-id=ACCOUNT_ID --date=2026-04-14 --amount=500.00
+officedesk-plugin-xero attach-to-bill --id=BILL_ID --file=./invoice.pdf
+```
+
+### `get-bank-statement-lines`
+
+Retrieve imported bank statement lines with `statementLineId`, `bankStatementId`, and `bankAccountId`.
+
+```bash
+officedesk-plugin-xero get-bank-statement-lines --bankAccountId=<BANK_ACCOUNT_ID>
+```
+
+**Options**
+
+| Flag | Description |
+|---|---|
+| `--bankAccountId=ID` | **(Required)** Bank account ID |
+| `--tenantId=ID` | Tenant ID override |
+| `--status=STATUS` | Line status (default: `unreconciled`) |
+| `--limit=N` | Maximum results (default: `50`) |
+| `--offset=N` | Pagination offset (default: `0`) |
+| `--output=PATH` | Override the cache output path |
+
+After you capture the browser session once, `get-bank-statement-lines` reuses the saved Xero auth data and does not launch a browser for each fetch.
+
+### `reconcile`
+
+Reconcile a bank transaction against a specific statement line.
+
+```bash
+officedesk-plugin-xero reconcile \
   --type=SPEND \
   --contactId=<CONTACT_ID> \
   --accountCode=<ACCOUNT_CODE> \
@@ -75,10 +146,18 @@ officedesk plugin-xero reconcile \
 
 If the saved browser session is missing, the reconcile flow can prompt for `browser-login` or run it automatically with `--auto-login`.
 
-## Binary build
+## Exact reconciliation flow
 
-Build the standalone plugin binary with:
+1. Create or identify the bank transaction you want to reconcile.
+2. Run `get-bank-statement-lines` to find the matching `statementLineId` and `bankStatementId`.
+3. Run `reconcile` against that exact line.
 
-```bash
-pnpm --filter @officedesk/plugin-xero build:bin
-```
+## Environment variables
+
+| Variable | Description |
+|---|---|
+| `OFFICEDESK_HOME` | Base directory for tokens and config (default: `~/.officedesk/`) |
+
+## License
+
+ISC

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@officedesk/plugin-xero",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Xero accounting integration plugin for officedesk-ai",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -14,8 +14,8 @@
     "access": "public"
   },
   "optionalDependencies": {
-    "@officedesk/plugin-xero-linux-x64": "0.0.2",
-    "@officedesk/plugin-xero-win32-x64": "0.0.2"
+    "@officedesk/plugin-xero-linux-x64": "0.0.4",
+    "@officedesk/plugin-xero-win32-x64": "0.0.4"
   },
   "scripts": {
     "build": "tsc",
@@ -70,6 +70,6 @@
   "license": "ISC",
   "repository": {
     "type": "git",
-    "url": "https://github.com/initdsg/officedesk.ai.git"
+    "url": "git+https://github.com/initdsg/officedesk.ai-cli.git"
   }
 }