Recipes

Create a Business Application with the scopes each recipe needs. Send:

Base path: /api. Replace https://api.example.com with your API host.

Scope: customers.create. Endpoint: POST /api/customers.

curl -X POST https://api.example.com/api/customers \
  -H "X-Client-Id: YOUR_CLIENT_ID" \
  -H "X-Client-Secret: YOUR_CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Retail",
    "email": "ops@acme.example",
    "address": "100 Market St",
    "status": "active"
  }'

Scope: invoices.create. Endpoint: POST /api/invoices. Provide from/to names, issue_date, and 1–10 items.

curl -X POST https://api.example.com/api/invoices \
  -H "X-Client-Id: YOUR_CLIENT_ID" \
  -H "X-Client-Secret: YOUR_CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "invoice_from_name": "Northwind LLC",
    "invoice_from_email": "billing@northwind.example",
    "invoice_to_name": "Acme Retail",
    "invoice_to_email": "ap@acme.example",
    "issue_date": "2026-09-01",
    "due_date": "2026-09-30",
    "items": [
      {
        "name": "Consulting",
        "description": "September retainer",
        "unit_type": "item",
        "unit_price": 500,
        "quantity": 1
      }
    ],
    "tax_amount": 0,
    "discount_amount": 0,
    "notes": "Net 30"
  }'

Scope: products.read. Endpoint: GET /api/products. Response includes success, total, limit, offset, data.

curl "https://api.example.com/api/products?limit=20&offset=0" \
  -H "X-Client-Id: YOUR_CLIENT_ID" \
  -H "X-Client-Secret: YOUR_CLIENT_SECRET"

Scope: invitations.create. Endpoint: POST /api/invitations. You need a Business role_id (roles are managed in the UI/session — not via Application scopes). Message is required.

curl -X POST https://api.example.com/api/invitations \
  -H "X-Client-Id: YOUR_CLIENT_ID" \
  -H "X-Client-Secret: YOUR_CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "teammate@example.com",
    "role_id": "00000000-0000-0000-0000-000000000000",
    "message": "Welcome to our Business on Application."
  }'