# Send Wafeq API Reference to your agent
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
## Fast path
- Download the package from Yavira.
- Extract it into a folder your agent can access.
- Paste one of the prompts below and point your agent at the extracted folder.
## Suggested prompts
### New install

```text
I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete.
```
### Upgrade existing

```text
I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run.
```
## Machine-readable fields
```json
{
  "schemaVersion": "1.0",
  "item": {
    "slug": "wafeq-api",
    "name": "Wafeq API Reference",
    "source": "tencent",
    "type": "skill",
    "category": "开发工具",
    "sourceUrl": "https://clawhub.ai/YordiLorenzo/wafeq-api",
    "canonicalUrl": "https://clawhub.ai/YordiLorenzo/wafeq-api",
    "targetPlatform": "OpenClaw"
  },
  "install": {
    "downloadUrl": "/downloads/wafeq-api",
    "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=wafeq-api",
    "sourcePlatform": "tencent",
    "targetPlatform": "OpenClaw",
    "packageFormat": "ZIP package",
    "primaryDoc": "SKILL.md",
    "includedAssets": [
      "SKILL.md",
      "references/accounts-banking-contacts.md",
      "references/bills-expenses-notes.md",
      "references/core-concepts.md",
      "references/enums.md",
      "references/invoices.md"
    ],
    "downloadMode": "redirect",
    "sourceHealth": {
      "source": "tencent",
      "slug": "wafeq-api",
      "status": "healthy",
      "reason": "direct_download_ok",
      "recommendedAction": "download",
      "checkedAt": "2026-05-10T19:27:16.008Z",
      "expiresAt": "2026-05-17T19:27:16.008Z",
      "httpStatus": 200,
      "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=wafeq-api",
      "contentType": "application/zip",
      "probeMethod": "head",
      "details": {
        "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=wafeq-api",
        "contentDisposition": "attachment; filename=\"wafeq-api-1.1.0.zip\"",
        "redirectLocation": null,
        "bodySnippet": null,
        "slug": "wafeq-api"
      },
      "scope": "item",
      "summary": "Item download looks usable.",
      "detail": "Yavira can redirect you to the upstream package for this item.",
      "primaryActionLabel": "Download for OpenClaw",
      "primaryActionHref": "/downloads/wafeq-api"
    },
    "validation": {
      "installChecklist": [
        "Use the Yavira download entry.",
        "Review SKILL.md after the package is downloaded.",
        "Confirm the extracted package contains the expected setup assets."
      ],
      "postInstallChecks": [
        "Confirm the extracted package includes the expected docs or setup files.",
        "Validate the skill or prompts are available in your target agent workspace.",
        "Capture any manual follow-up steps the agent could not complete."
      ]
    }
  },
  "links": {
    "detailUrl": "https://openagent3.xyz/skills/wafeq-api",
    "downloadUrl": "https://openagent3.xyz/downloads/wafeq-api",
    "agentUrl": "https://openagent3.xyz/skills/wafeq-api/agent",
    "manifestUrl": "https://openagent3.xyz/skills/wafeq-api/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/wafeq-api/agent.md"
  }
}
```
## Documentation

### Wafeq API Skill

Complete API reference for the Wafeq accounting and e-invoicing platform.

### Setup

To use this skill, you need a Wafeq API key:

Log in to Wafeq
Go to Settings → API Keys (direct link)
Create a new API key
Set the environment variable:
export WAFEQ_API_KEY='your-key-here'

Or configure in ~/.openclaw/openclaw.json:
{ "skills": { "entries": { "wafeq-api": { "apiKey": "your-key-here" } } } }

⚠️ Security: Never hardcode your API key in code, prompts, or skill files. Always use the WAFEQ_API_KEY environment variable or configure it via skills.entries.wafeq-api.apiKey in ~/.openclaw/openclaw.json.

You can validate your setup by running scripts/setup.sh from the plugin root.

### Quick Reference

Base URL: https://api.wafeq.com/v1/
Auth (API Key): Authorization: Api-Key $WAFEQ_API_KEY — get keys at https://app.wafeq.com/c/api-keys
Auth (OAuth2): Authorization: Bearer <access_token> — contact Wafeq for client credentials
Idempotency: X-Wafeq-Idempotency-Key: <uuid-v4> on POST/PUT/PATCH/DELETE (1hr cache, replayed response includes X-Wafeq-Idempotent-Replayed: true)
Pagination: ?page=1&page_size=25 — response: { count, next, previous, results[] }
Content-Type: application/json
Currency codes: ISO 4217 (full list in references/enums.md)
Entity IDs: Prefixed strings (e.g. cnt_..., acc_..., inv_...)

### Standard CRUD Pattern

Most resources follow: POST /{resource}/, GET /{resource}/, GET /{resource}/{id}/, PUT /{resource}/{id}/, PATCH /{resource}/{id}/, DELETE /{resource}/{id}/. Some also have GET /{resource}/{id}/download/ for PDF.

Line items are nested: /{resource}/{parent_id}/line-items/ with the same CRUD pattern.

### Reference Files

FileContentsreferences/core-concepts.mdAuthentication (API Key + OAuth2), idempotency, error handling, quickstart guide, invoice creation walkthrough, use cases (B2B, B2C, e-commerce, expense management)references/enums.mdAll 18 enum types: currencies, statuses, classifications, tax types, discount types, languagesreferences/invoices.mdStandard invoices, invoice line items, bulk invoices (api-invoices), simplified invoices, simplified invoice line items — full CRUD + schemasreferences/accounts-banking-contacts.mdChart of accounts, bank accounts, bank ledger transactions, bank statement transactions, contacts, beneficiaries — full CRUD + schemasreferences/bills-expenses-notes.mdBills, bill line items, expenses, credit notes, credit note line items, bulk credit notes, debit notes, debit note line items — full CRUD + schemasreferences/quotes-payments-remaining.mdQuotes, payments, payment requests, payslips, items, files, manual journals, journal line items, reports (balance sheet, P&L, cash flow, trial balance), organization, tax rates, branches, cost centers, employees, projects, warehouses — full CRUD + schemas

### Create and Send an Invoice

Create contact: POST /contacts/
Get revenue account: GET /accounts/?classification=REVENUE
Get tax rates: GET /tax-rates/
Create invoice: POST /invoices/ (with line_items, contact, currency, invoice_date, invoice_due_date, invoice_number)
Report to tax authority: POST /invoices/{id}/tax-authority/report/
Download PDF: GET /invoices/{id}/download/

### Bulk Send Invoices (E-Commerce / High Volume)

POST /api-invoices/bulk_send/ with array of invoice objects including channels for email delivery
Response: { "queued": N }
Generate summary: GET /api-invoices/summary/

### Record Expense

Get expense account: GET /accounts/?classification=EXPENSE
Create expense: POST /expenses/ with paid_through_account, contact, date, currency, tax_amount_type, line_items

### Record Payment Against Invoice

POST /payments/ with invoice_payments array linking to invoice IDs and amounts

### Generate Financial Reports

Balance Sheet: GET /reports/balance-sheet/?currency=SAR&date=2025-12-31
Profit & Loss: GET /reports/profit-and-loss/?currency=SAR&date_after=2025-01-01&date_before=2025-12-31
Cash Flow: GET /reports/cash-flow/?currency=SAR&date_after=2025-01-01&date_before=2025-12-31
Trial Balance: GET /reports/trial-balance/?from_date=2025-01-01&to_date=2025-12-31

### Quote to Invoice Conversion

Create quote: POST /quotes/
Convert to invoice: POST /quotes/{id}/invoice/

### Important Notes

Tax authority reporting is available for invoices, simplified invoices, and credit notes via POST /{resource}/{id}/tax-authority/report/
Simplified invoices are for B2C transactions (no buyer tax registration required)
Standard invoices are for B2B transactions
Place of supply field is UAE-specific (emirate codes or OUTSIDE_UAE)
Use reference fields as unique identifiers to prevent duplicate creation
## Trust
- Source: tencent
- Verification: Indexed source record
- Publisher: YordiLorenzo
- Version: 1.1.0
## Source health
- Status: healthy
- Item download looks usable.
- Yavira can redirect you to the upstream package for this item.
- Health scope: item
- Reason: direct_download_ok
- Checked at: 2026-05-10T19:27:16.008Z
- Expires at: 2026-05-17T19:27:16.008Z
- Recommended action: Download for OpenClaw
## Links
- [Detail page](https://openagent3.xyz/skills/wafeq-api)
- [Send to Agent page](https://openagent3.xyz/skills/wafeq-api/agent)
- [JSON manifest](https://openagent3.xyz/skills/wafeq-api/agent.json)
- [Markdown brief](https://openagent3.xyz/skills/wafeq-api/agent.md)
- [Download page](https://openagent3.xyz/downloads/wafeq-api)