@letsbot/sdk 0.2.0 → 0.5.0

package/openapi/erp-v1.yaml

@@ -0,0 +1,3090 @@
+# LetsBot Business (ERP) public API — generated twin: erp-v1.json (keep both in step).
+openapi: 3.1.0
+info:
+  title: LetsBot Business (ERP) API
+  version: 1.0.0
+  description: 'Public REST API of LetsBot Business («الأعمال»): https://{workspace}.letsbot.net/api/v1/erp.
+
+
+    Auth: the workspace API key in `X-Zapier-Api-Key` (Integrations → Zapier → API keys) with the `erp` scope ticked explicitly. Envelope `{success, data, meta?}` / `{success: false, error, code, errors?,
+    params?}`. Money and quantities are 4-dp decimal strings. Each area answers 404 until the workspace switches it on. Writes create drafts or take the explicit step you call (confirm, issue, record a
+    payment); nothing here messages a customer. Rate limit 120 requests/min per key (subscribe 30/min). Every POST accepts `Idempotency-Key` (24 h replay, `Idempotent-Replayed: true`).
+
+
+    Webhooks: subscribe with POST /hooks; deliveries are signed `X-LetsBot-Signature: t=<unix>,v1=<HMAC-SHA256 hex of "<t>.<raw body>">` with the subscription secret (reject t older than 5 minutes).'
+servers:
+- url: https://{workspace}.letsbot.net/api/v1/erp
+  variables:
+    workspace:
+      default: your-workspace
+      description: Your LetsBot workspace subdomain
+security:
+- zapierApiKey: []
+tags:
+- name: Inventory
+- name: Sales
+- name: Purchasing
+- name: Expenses
+- name: Accounting
+- name: Webhooks
+paths:
+  /hooks:
+    get:
+      operationId: erpListHooks
+      summary: List ERP webhook subscriptions made through the API
+      tags:
+      - Webhooks
+      description: 'Scope: `erp`. Area: `erp_core` (404 while the workspace has not switched on Business (ERP)).'
+      security:
+      - zapierApiKey: []
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Hook'
+                  meta:
+                    $ref: '#/components/schemas/PageMeta'
+        '401': &id001
+          $ref: '#/components/responses/Unauthorized'
+        '403': &id002
+          $ref: '#/components/responses/MissingScope'
+        '404': &id003
+          $ref: '#/components/responses/NotFound'
+        '422': &id004
+          $ref: '#/components/responses/Unprocessable'
+        '429': &id005
+          $ref: '#/components/responses/TooManyRequests'
+    post:
+      operationId: erpSubscribeHook
+      summary: Subscribe to ERP events (REST hook)
+      tags:
+      - Webhooks
+      description: 'Zapier sends {target_url, event}. https only, public addresses. Only events of areas the workspace switched on.
+
+
+        Scope: `erp`. Area: `erp_core` (404 while the workspace has not switched on Business (ERP)).'
+      security:
+      - zapierApiKey: []
+      responses:
+        '201':
+          description: Created; `secret` (whsec_…) is returned once.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/Hook'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: []
+              properties:
+                target_url:
+                  type: string
+                  format: uri
+                url:
+                  type: string
+                  format: uri
+                event:
+                  type: string
+                events:
+                  type: array
+                  items:
+                    type: string
+                source:
+                  type: string
+                  enum:
+                  - zapier
+                  - make
+                  - n8n
+                  - api
+                description:
+                  type: string
+  /hooks/{id}:
+    delete:
+      operationId: erpUnsubscribeHook
+      summary: Delete an API-made ERP subscription
+      tags:
+      - Webhooks
+      description: 'Scope: `erp`. Area: `erp_core` (404 while the workspace has not switched on Business (ERP)).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - &id006
+        name: id
+        in: path
+        required: true
+        schema:
+          type: integer
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/Hook'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /hooks/events:
+    get:
+      operationId: erpHookEvents
+      summary: ERP event catalogue
+      tags:
+      - Webhooks
+      description: 'Scope: `erp`. Area: `erp_core` (404 while the workspace has not switched on Business (ERP)).'
+      security:
+      - zapierApiKey: []
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/HookEvent'
+                  meta:
+                    $ref: '#/components/schemas/PageMeta'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /hooks/sample:
+    get:
+      operationId: erpHookSample
+      summary: Sample payload for an event (latest record)
+      tags:
+      - Webhooks
+      description: 'Scope: `erp`. Area: `erp_core` (404 while the workspace has not switched on Business (ERP)).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - name: event
+        in: query
+        required: true
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/WebhookDelivery'
+                  meta:
+                    $ref: '#/components/schemas/PageMeta'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /inventory/items:
+    get:
+      operationId: erpListItems
+      summary: List items (with variants)
+      tags:
+      - Inventory
+      description: 'Scope: `erp`. Area: `erp_inventory` (404 while the workspace has not switched on Inventory).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - &id007
+        $ref: '#/components/parameters/Page'
+      - &id008
+        $ref: '#/components/parameters/PerPage'
+      - name: search
+        in: query
+        required: false
+        description: Name or SKU
+        schema:
+          type: string
+      - name: status
+        in: query
+        required: false
+        description: active,archived
+        schema:
+          type: string
+      - name: type
+        in: query
+        required: false
+        description: stock,service,kit,consumable
+        schema:
+          type: string
+      - name: low_only
+        in: query
+        required: false
+        description: Below reorder point
+        schema:
+          type: boolean
+      - &id009
+        $ref: '#/components/parameters/UpdatedSince'
+      - &id010
+        $ref: '#/components/parameters/CreatedSince'
+      - &id011
+        $ref: '#/components/parameters/Sort'
+      - &id012
+        $ref: '#/components/parameters/Dir'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Item'
+                  meta:
+                    $ref: '#/components/schemas/PageMeta'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /inventory/items/{id}:
+    get:
+      operationId: erpGetItem
+      summary: Get an item
+      tags:
+      - Inventory
+      description: 'Scope: `erp`. Area: `erp_inventory` (404 while the workspace has not switched on Inventory).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id006
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/Item'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /inventory/variants:
+    get:
+      operationId: erpListVariants
+      summary: List / find variants (exact sku=)
+      tags:
+      - Inventory
+      description: 'Scope: `erp`. Area: `erp_inventory` (404 while the workspace has not switched on Inventory).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id007
+      - *id008
+      - name: sku
+        in: query
+        required: false
+        description: Exact SKU
+        schema:
+          type: string
+      - name: search
+        in: query
+        required: false
+        description: Text
+        schema:
+          type: string
+      - name: item_id
+        in: query
+        required: false
+        description: Item id
+        schema:
+          type: integer
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Variant'
+                  meta:
+                    $ref: '#/components/schemas/PageMeta'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /inventory/warehouses:
+    get:
+      operationId: erpListWarehouses
+      summary: List warehouses
+      tags:
+      - Inventory
+      description: 'Scope: `erp`. Area: `erp_inventory` (404 while the workspace has not switched on Inventory).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id007
+      - *id008
+      - name: status
+        in: query
+        required: false
+        description: active,archived
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Warehouse'
+                  meta:
+                    $ref: '#/components/schemas/PageMeta'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /inventory/stock-levels:
+    get:
+      operationId: erpListStockLevels
+      summary: Stock levels per variant × warehouse
+      tags:
+      - Inventory
+      description: 'Scope: `erp`. Area: `erp_inventory` (404 while the workspace has not switched on Inventory).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id007
+      - *id008
+      - name: sku
+        in: query
+        required: false
+        description: Exact SKU
+        schema:
+          type: string
+      - name: variant_id
+        in: query
+        required: false
+        description: Variant
+        schema:
+          type: integer
+      - name: warehouse_id
+        in: query
+        required: false
+        description: Warehouse
+        schema:
+          type: integer
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/StockLevel'
+                  meta:
+                    $ref: '#/components/schemas/PageMeta'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /inventory/stock-moves:
+    get:
+      operationId: erpListStockMoves
+      summary: Stock ledger (append-only; poll with after_id)
+      tags:
+      - Inventory
+      description: 'Scope: `erp`. Area: `erp_inventory` (404 while the workspace has not switched on Inventory).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id007
+      - *id008
+      - name: after_id
+        in: query
+        required: false
+        description: Only moves after this id, oldest first
+        schema:
+          type: integer
+      - name: variant_id
+        in: query
+        required: false
+        description: Variant
+        schema:
+          type: integer
+      - name: warehouse_id
+        in: query
+        required: false
+        description: Warehouse
+        schema:
+          type: integer
+      - name: move_type
+        in: query
+        required: false
+        description: Comma list
+        schema:
+          type: string
+      - name: since
+        in: query
+        required: false
+        description: moved_at ≥ (ISO-8601)
+        schema:
+          type: string
+      - name: until
+        in: query
+        required: false
+        description: moved_at ≤ (ISO-8601)
+        schema:
+          type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/StockMove'
+                  meta:
+                    $ref: '#/components/schemas/PageMeta'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /sales/customers:
+    get:
+      operationId: erpListCustomers
+      summary: List customers
+      tags:
+      - Sales
+      description: 'Scope: `erp`. Area: `erp_sales` (404 while the workspace has not switched on Sales).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id007
+      - *id008
+      - name: search
+        in: query
+        required: false
+        description: Name, legal name or VAT
+        schema:
+          type: string
+      - name: contact_id
+        in: query
+        required: false
+        description: CRM contact
+        schema:
+          type: integer
+      - name: company_id
+        in: query
+        required: false
+        description: CRM company
+        schema:
+          type: integer
+      - *id009
+      - *id010
+      - *id011
+      - *id012
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Customer'
+                  meta:
+                    $ref: '#/components/schemas/PageMeta'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /sales/customers/{id}:
+    get:
+      operationId: erpGetCustomer
+      summary: Get a customer
+      tags:
+      - Sales
+      description: 'Scope: `erp`. Area: `erp_sales` (404 while the workspace has not switched on Sales).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id006
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/Customer'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /sales/customers/{id}/statement:
+    get:
+      operationId: erpCustomerStatement
+      summary: Customer statement of account (+ PDF link)
+      tags:
+      - Sales
+      description: 'Scope: `erp`. Area: `erp_sales` (404 while the workspace has not switched on Sales).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id006
+      - name: from
+        in: query
+        required: false
+        description: Y-m-d (default today − 89 days)
+        schema:
+          type: string
+          format: date
+      - name: to
+        in: query
+        required: false
+        description: Y-m-d (default today)
+        schema:
+          type: string
+          format: date
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/Statement'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /sales/orders:
+    get:
+      operationId: erpListSalesOrders
+      summary: List sales orders
+      tags:
+      - Sales
+      description: 'Scope: `erp`. Area: `erp_sales` (404 while the workspace has not switched on Sales).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id007
+      - *id008
+      - name: status
+        in: query
+        required: false
+        description: Comma list
+        schema:
+          type: string
+      - name: customer_id
+        in: query
+        required: false
+        description: Customer
+        schema:
+          type: integer
+      - name: contact_id
+        in: query
+        required: false
+        description: CRM contact
+        schema:
+          type: integer
+      - name: company_id
+        in: query
+        required: false
+        description: CRM company
+        schema:
+          type: integer
+      - *id009
+      - *id010
+      - *id011
+      - *id012
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/SalesOrder'
+                  meta:
+                    $ref: '#/components/schemas/PageMeta'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+    post:
+      operationId: erpCreateSalesOrder
+      summary: Create a DRAFT sales order
+      tags:
+      - Sales
+      description: 'Reserves nothing and messages nobody until confirmed.
+
+
+        Scope: `erp`. Area: `erp_sales` (404 while the workspace has not switched on Sales).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - $ref: '#/components/parameters/IdempotencyKey'
+      responses:
+        '201':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/SalesOrder'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+              - lines
+              properties:
+                customer_id: &id014
+                  type: integer
+                  description: ERP customer id
+                contact_id: &id015
+                  type: integer
+                  description: CRM contact id (customer profile created when missing)
+                company_id: &id016
+                  type: integer
+                  description: CRM company id
+                lines:
+                  type: array
+                  minItems: 1
+                  items:
+                    $ref: '#/components/schemas/LineIn'
+                warehouse_id: &id013
+                  type: integer
+                currency:
+                  type: string
+                prices_include_tax:
+                  type: boolean
+                payment_method:
+                  type: string
+                  enum:
+                  - link
+                  - cod
+                  - bank
+                  - cash
+                  - credit
+                payment_terms_days: *id013
+                delivery_date:
+                  type: string
+                  format: date
+                shipping_address:
+                  type: object
+                deal_id: *id013
+                notes:
+                  type: string
+                reference:
+                  type: string
+                  description: Your reference (stored as source_ref).
+  /sales/orders/{id}:
+    get:
+      operationId: erpGetSalesOrder
+      summary: Get a sales order
+      tags:
+      - Sales
+      description: 'Scope: `erp`. Area: `erp_sales` (404 while the workspace has not switched on Sales).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id006
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/SalesOrder'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /sales/orders/{id}/confirm:
+    post:
+      operationId: erpConfirmSalesOrder
+      summary: Confirm a draft order (credit check, number, stock reservation)
+      tags:
+      - Sales
+      description: 'Scope: `erp`. Area: `erp_sales` (404 while the workspace has not switched on Sales).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id006
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/SalesOrder'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /sales/invoices:
+    get:
+      operationId: erpListInvoices
+      summary: List invoices (tax, simplified, debit notes)
+      tags:
+      - Sales
+      description: 'Scope: `erp`. Area: `erp_sales` (404 while the workspace has not switched on Sales).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id007
+      - *id008
+      - name: doc_type
+        in: query
+        required: false
+        description: tax,simplified,debit_note
+        schema:
+          type: string
+      - name: status
+        in: query
+        required: false
+        description: Comma list
+        schema:
+          type: string
+      - name: einvoice_status
+        in: query
+        required: false
+        description: Comma list
+        schema:
+          type: string
+      - name: overdue
+        in: query
+        required: false
+        description: Open and past due
+        schema:
+          type: boolean
+      - name: customer_id
+        in: query
+        required: false
+        description: Customer
+        schema:
+          type: integer
+      - name: order_id
+        in: query
+        required: false
+        description: Sales order
+        schema:
+          type: integer
+      - *id009
+      - *id010
+      - *id011
+      - *id012
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Invoice'
+                  meta:
+                    $ref: '#/components/schemas/PageMeta'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+    post:
+      operationId: erpCreateInvoice
+      summary: Create a DRAFT invoice (lines, or order_id = what is left on that order)
+      tags:
+      - Sales
+      description: 'Scope: `erp`. Area: `erp_sales` (404 while the workspace has not switched on Sales).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - $ref: '#/components/parameters/IdempotencyKey'
+      responses:
+        '201':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/Invoice'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: []
+              properties:
+                customer_id: *id014
+                contact_id: *id015
+                company_id: *id016
+                order_id: *id013
+                doc_type:
+                  type: string
+                  enum:
+                  - tax
+                  - simplified
+                lines:
+                  type: array
+                  items:
+                    $ref: '#/components/schemas/LineIn'
+                currency:
+                  type: string
+                issue_date:
+                  type: string
+                  format: date
+                supply_date:
+                  type: string
+                  format: date
+                due_date:
+                  type: string
+                  format: date
+                prices_include_tax:
+                  type: boolean
+                payment_terms_days: *id013
+                deal_id: *id013
+                notes:
+                  type: string
+  /sales/invoices/{id}:
+    get:
+      operationId: erpGetInvoice
+      summary: Get an invoice
+      tags:
+      - Sales
+      description: 'Scope: `erp`. Area: `erp_sales` (404 while the workspace has not switched on Sales).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id006
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/Invoice'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /sales/invoices/{id}/issue:
+    post:
+      operationId: erpIssueInvoice
+      summary: Issue a draft invoice (number, QR, e-invoice submission when on)
+      tags:
+      - Sales
+      description: 'Scope: `erp`. Area: `erp_sales` (404 while the workspace has not switched on Sales).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id006
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/Invoice'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /sales/invoices/{id}/pdf:
+    get:
+      operationId: erpInvoicePdfLink
+      summary: Customer PDF / page link (only once shareable)
+      tags:
+      - Sales
+      description: 'Scope: `erp`. Area: `erp_sales` (404 while the workspace has not switched on Sales).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id006
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/InvoiceLinks'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /sales/invoices/{id}/credit-notes:
+    post:
+      operationId: erpCreateCreditNote
+      summary: Create a DRAFT credit note against an issued invoice
+      tags:
+      - Sales
+      description: 'Scope: `erp`. Area: `erp_sales` (404 while the workspace has not switched on Sales).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id006
+      - $ref: '#/components/parameters/IdempotencyKey'
+      responses:
+        '201':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/Invoice'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+              - reason
+              - lines
+              properties:
+                reason:
+                  type: string
+                  enum:
+                  - return
+                  - price_adjustment
+                  - discount
+                  - cancellation
+                  - damaged
+                  - other
+                lines:
+                  type: array
+                  minItems: 1
+                  items:
+                    type: object
+                    required:
+                    - invoice_line_id
+                    properties:
+                      invoice_line_id: *id013
+                      qty:
+                        type: number
+                      amount:
+                        type: number
+                        description: Net, excl. VAT
+  /sales/credit-notes:
+    get:
+      operationId: erpListCreditNotes
+      summary: List credit notes
+      tags:
+      - Sales
+      description: 'Scope: `erp`. Area: `erp_sales` (404 while the workspace has not switched on Sales).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id007
+      - *id008
+      - name: status
+        in: query
+        required: false
+        description: Comma list
+        schema:
+          type: string
+      - name: customer_id
+        in: query
+        required: false
+        description: Customer
+        schema:
+          type: integer
+      - *id009
+      - *id010
+      - *id011
+      - *id012
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Invoice'
+                  meta:
+                    $ref: '#/components/schemas/PageMeta'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /sales/credit-notes/{id}:
+    get:
+      operationId: erpGetCreditNote
+      summary: Get a credit note
+      tags:
+      - Sales
+      description: 'Scope: `erp`. Area: `erp_sales` (404 while the workspace has not switched on Sales).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id006
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/Invoice'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /sales/credit-notes/{id}/issue:
+    post:
+      operationId: erpIssueCreditNote
+      summary: Issue a draft credit note
+      tags:
+      - Sales
+      description: 'Scope: `erp`. Area: `erp_sales` (404 while the workspace has not switched on Sales).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id006
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/Invoice'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /sales/payments:
+    get:
+      operationId: erpListPayments
+      summary: List payments
+      tags:
+      - Sales
+      description: 'Scope: `erp`. Area: `erp_sales` (404 while the workspace has not switched on Sales).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id007
+      - *id008
+      - name: direction
+        in: query
+        required: false
+        description: in,out
+        schema:
+          type: string
+      - name: method
+        in: query
+        required: false
+        description: Comma list
+        schema:
+          type: string
+      - name: customer_id
+        in: query
+        required: false
+        description: Customer
+        schema:
+          type: integer
+      - *id009
+      - *id010
+      - *id011
+      - *id012
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Payment'
+                  meta:
+                    $ref: '#/components/schemas/PageMeta'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+    post:
+      operationId: erpRecordPayment
+      summary: Record a customer payment (receipt)
+      tags:
+      - Sales
+      description: 'Scope: `erp`. Area: `erp_sales` (404 while the workspace has not switched on Sales).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - $ref: '#/components/parameters/IdempotencyKey'
+      responses:
+        '201':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/Payment'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+              - amount
+              - method
+              properties:
+                customer_id: *id014
+                contact_id: *id015
+                company_id: *id016
+                amount:
+                  type: number
+                  exclusiveMinimum: 0
+                method:
+                  type: string
+                  enum:
+                  - gateway
+                  - cash
+                  - bank_transfer
+                  - cod
+                  - card_pos
+                  - bnpl
+                  - store_credit
+                currency:
+                  type: string
+                fx_rate:
+                  type: number
+                received_at:
+                  type: string
+                  format: date-time
+                reference:
+                  type: string
+                provider:
+                  type: string
+                provider_payment_id:
+                  type: string
+                  description: 'With provider: idempotent on the provider id.'
+                allocations:
+                  type: array
+                  items:
+                    type: object
+                    required:
+                    - invoice_id
+                    - amount
+                    properties:
+                      invoice_id: *id013
+                      amount:
+                        type: number
+                  description: Omit = oldest due first.
+  /sales/payments/{id}:
+    get:
+      operationId: erpGetPayment
+      summary: Get a payment
+      tags:
+      - Sales
+      description: 'Scope: `erp`. Area: `erp_sales` (404 while the workspace has not switched on Sales).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id006
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/Payment'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /purchasing/suppliers:
+    get:
+      operationId: erpListSuppliers
+      summary: List suppliers
+      tags:
+      - Purchasing
+      description: 'Scope: `erp`. Area: `erp_purchasing` (404 while the workspace has not switched on Purchasing).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id007
+      - *id008
+      - name: search
+        in: query
+        required: false
+        description: Name, code or VAT
+        schema:
+          type: string
+      - name: status
+        in: query
+        required: false
+        description: Comma list
+        schema:
+          type: string
+      - *id009
+      - *id010
+      - *id011
+      - *id012
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Supplier'
+                  meta:
+                    $ref: '#/components/schemas/PageMeta'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /purchasing/suppliers/{id}:
+    get:
+      operationId: erpGetSupplier
+      summary: Get a supplier
+      tags:
+      - Purchasing
+      description: 'Scope: `erp`. Area: `erp_purchasing` (404 while the workspace has not switched on Purchasing).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id006
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/Supplier'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /purchasing/purchase-orders:
+    get:
+      operationId: erpListPurchaseOrders
+      summary: List purchase orders
+      tags:
+      - Purchasing
+      description: 'Scope: `erp`. Area: `erp_purchasing` (404 while the workspace has not switched on Purchasing).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id007
+      - *id008
+      - name: status
+        in: query
+        required: false
+        description: Comma list
+        schema:
+          type: string
+      - name: supplier_reply
+        in: query
+        required: false
+        description: Comma list
+        schema:
+          type: string
+      - name: supplier_id
+        in: query
+        required: false
+        description: Supplier
+        schema:
+          type: integer
+      - name: warehouse_id
+        in: query
+        required: false
+        description: Warehouse
+        schema:
+          type: integer
+      - *id009
+      - *id010
+      - *id011
+      - *id012
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/PurchaseOrder'
+                  meta:
+                    $ref: '#/components/schemas/PageMeta'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+    post:
+      operationId: erpCreatePurchaseOrder
+      summary: Create a DRAFT purchase order
+      tags:
+      - Purchasing
+      description: 'Approval and sending to the supplier stay with a person in the panel.
+
+
+        Scope: `erp`. Area: `erp_purchasing` (404 while the workspace has not switched on Purchasing).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - $ref: '#/components/parameters/IdempotencyKey'
+      responses:
+        '201':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/PurchaseOrder'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+              - supplier_id
+              - lines
+              properties:
+                supplier_id: *id013
+                warehouse_id: *id013
+                order_date:
+                  type: string
+                  format: date
+                expected_date:
+                  type: string
+                  format: date
+                payment_terms_days: *id013
+                currency:
+                  type: string
+                fx_rate:
+                  type: number
+                notes:
+                  type: string
+                lines:
+                  type: array
+                  minItems: 1
+                  items:
+                    type: object
+                    required:
+                    - qty
+                    properties:
+                      variant_id: *id013
+                      sku:
+                        type: string
+                      name:
+                        type: string
+                      supplier_sku:
+                        type: string
+                      qty:
+                        type: number
+                      unit_price:
+                        type: number
+                      discount_pct:
+                        type: number
+                      tax_rate:
+                        type: number
+                      uom_id: *id013
+  /purchasing/purchase-orders/{id}:
+    get:
+      operationId: erpGetPurchaseOrder
+      summary: Get a purchase order
+      tags:
+      - Purchasing
+      description: 'Scope: `erp`. Area: `erp_purchasing` (404 while the workspace has not switched on Purchasing).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id006
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/PurchaseOrder'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /purchasing/bills:
+    get:
+      operationId: erpListBills
+      summary: List supplier bills
+      tags:
+      - Purchasing
+      description: 'Scope: `erp`. Area: `erp_purchasing` (404 while the workspace has not switched on Purchasing).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id007
+      - *id008
+      - name: status
+        in: query
+        required: false
+        description: Comma list
+        schema:
+          type: string
+      - name: kind
+        in: query
+        required: false
+        description: goods,landed,expense
+        schema:
+          type: string
+      - name: supplier_id
+        in: query
+        required: false
+        description: Supplier
+        schema:
+          type: integer
+      - name: purchase_order_id
+        in: query
+        required: false
+        description: PO
+        schema:
+          type: integer
+      - *id009
+      - *id010
+      - *id011
+      - *id012
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Bill'
+                  meta:
+                    $ref: '#/components/schemas/PageMeta'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /purchasing/bills/{id}:
+    get:
+      operationId: erpGetBill
+      summary: Get a supplier bill
+      tags:
+      - Purchasing
+      description: 'Scope: `erp`. Area: `erp_purchasing` (404 while the workspace has not switched on Purchasing).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id006
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/Bill'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /expenses/categories:
+    get:
+      operationId: erpListExpenseCategories
+      summary: List active expense categories
+      tags:
+      - Expenses
+      description: 'Scope: `erp`. Area: `erp_expenses` (404 while the workspace has not switched on Expenses).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id007
+      - *id008
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/ExpenseCategory'
+                  meta:
+                    $ref: '#/components/schemas/PageMeta'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /expenses:
+    get:
+      operationId: erpListExpenses
+      summary: List expenses
+      tags:
+      - Expenses
+      description: 'Scope: `erp`. Area: `erp_expenses` (404 while the workspace has not switched on Expenses).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id007
+      - *id008
+      - name: status
+        in: query
+        required: false
+        description: Comma list
+        schema:
+          type: string
+      - name: category_id
+        in: query
+        required: false
+        description: Category
+        schema:
+          type: integer
+      - name: supplier_id
+        in: query
+        required: false
+        description: Supplier
+        schema:
+          type: integer
+      - *id009
+      - *id010
+      - *id011
+      - *id012
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Expense'
+                  meta:
+                    $ref: '#/components/schemas/PageMeta'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+    post:
+      operationId: erpCreateExpense
+      summary: Create a DRAFT expense
+      tags:
+      - Expenses
+      description: 'Submit / approve / post stay with a person (approval threshold and self-approval rules apply).
+
+
+        Scope: `erp`. Area: `erp_expenses` (404 while the workspace has not switched on Expenses).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - $ref: '#/components/parameters/IdempotencyKey'
+      responses:
+        '201':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/Expense'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+              - description
+              - amount
+              properties:
+                expense_date:
+                  type: string
+                  format: date
+                category_id: *id013
+                category_code:
+                  type: string
+                description:
+                  type: string
+                vendor_name:
+                  type: string
+                vendor_vat_number:
+                  type: string
+                receipt_number:
+                  type: string
+                is_tax_invoice:
+                  type: boolean
+                currency:
+                  type: string
+                fx_rate:
+                  type: number
+                amount:
+                  type: number
+                  description: Total paid incl. VAT
+                vat_amount:
+                  type: number
+                paid_from:
+                  type: string
+                  enum:
+                  - cash
+                  - bank
+                  - card
+                  - payable
+                notes:
+                  type: string
+  /expenses/{id}:
+    get:
+      operationId: erpGetExpense
+      summary: Get an expense
+      tags:
+      - Expenses
+      description: 'Scope: `erp`. Area: `erp_expenses` (404 while the workspace has not switched on Expenses).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id006
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/Expense'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /accounting/accounts:
+    get:
+      operationId: erpListAccounts
+      summary: Chart of accounts
+      tags:
+      - Accounting
+      description: 'Scope: `erp`. Area: `erp_accounting` (404 while the workspace has not switched on Accounting).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id007
+      - *id008
+      - name: type
+        in: query
+        required: false
+        description: Comma list
+        schema:
+          type: string
+      - name: include_inactive
+        in: query
+        required: false
+        description: Also inactive
+        schema:
+          type: boolean
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Account'
+                  meta:
+                    $ref: '#/components/schemas/PageMeta'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /accounting/journal-entries:
+    get:
+      operationId: erpListJournalEntries
+      summary: List journal entries
+      tags:
+      - Accounting
+      description: 'Scope: `erp`. Area: `erp_accounting` (404 while the workspace has not switched on Accounting).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id007
+      - *id008
+      - name: from
+        in: query
+        required: false
+        description: entry_date ≥
+        schema:
+          type: string
+          format: date
+      - name: to
+        in: query
+        required: false
+        description: entry_date ≤
+        schema:
+          type: string
+          format: date
+      - name: kind
+        in: query
+        required: false
+        description: Comma list
+        schema:
+          type: string
+      - name: document_type
+        in: query
+        required: false
+        description: Comma list
+        schema:
+          type: string
+      - name: document_id
+        in: query
+        required: false
+        description: Document
+        schema:
+          type: integer
+      - name: after_id
+        in: query
+        required: false
+        description: Only entries after this id, oldest first
+        schema:
+          type: integer
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/JournalEntry'
+                  meta:
+                    $ref: '#/components/schemas/PageMeta'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /accounting/journal-entries/{id}:
+    get:
+      operationId: erpGetJournalEntry
+      summary: Get a journal entry
+      tags:
+      - Accounting
+      description: 'Scope: `erp`. Area: `erp_accounting` (404 while the workspace has not switched on Accounting).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - *id006
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/JournalEntry'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /accounting/reports/profit-and-loss:
+    get:
+      operationId: erpReportProfitAndLoss
+      summary: Profit & loss
+      tags:
+      - Accounting
+      description: 'Scope: `erp`. Area: `erp_accounting` (404 while the workspace has not switched on Accounting).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - name: from
+        in: query
+        required: false
+        description: 'Default: first day of this month'
+        schema:
+          type: string
+          format: date
+      - name: to
+        in: query
+        required: false
+        description: 'Default: today'
+        schema:
+          type: string
+          format: date
+      - name: branch_id
+        in: query
+        required: false
+        description: Branch
+        schema:
+          type: integer
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/Report'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /accounting/reports/balance-sheet:
+    get:
+      operationId: erpReportBalanceSheet
+      summary: Balance sheet
+      tags:
+      - Accounting
+      description: 'Scope: `erp`. Area: `erp_accounting` (404 while the workspace has not switched on Accounting).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - name: as_of
+        in: query
+        required: false
+        description: 'Default: today'
+        schema:
+          type: string
+          format: date
+      - name: branch_id
+        in: query
+        required: false
+        description: Branch
+        schema:
+          type: integer
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/Report'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+  /accounting/reports/vat:
+    get:
+      operationId: erpReportVat
+      summary: VAT return summary (country layout)
+      tags:
+      - Accounting
+      description: 'Scope: `erp`. Area: `erp_accounting` (404 while the workspace has not switched on Accounting).'
+      security:
+      - zapierApiKey: []
+      parameters:
+      - name: from
+        in: query
+        required: false
+        description: 'Default: first day of this month'
+        schema:
+          type: string
+          format: date
+      - name: to
+        in: query
+        required: false
+        description: 'Default: today'
+        schema:
+          type: string
+          format: date
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    const: true
+                  data:
+                    $ref: '#/components/schemas/Report'
+        '401': *id001
+        '403': *id002
+        '404': *id003
+        '422': *id004
+        '429': *id005
+webhooks:
+  invoice.issued:
+    post:
+      operationId: erpWebhookInvoiceIssued
+      summary: invoice.issued
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/WebhookDelivery'
+      responses:
+        '200':
+          description: Received
+        '410':
+          description: Gone — unsubscribes
+  invoice.paid:
+    post:
+      operationId: erpWebhookInvoicePaid
+      summary: invoice.paid
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/WebhookDelivery'
+      responses:
+        '200':
+          description: Received
+        '410':
+          description: Gone — unsubscribes
+  invoice.cleared:
+    post:
+      operationId: erpWebhookInvoiceCleared
+      summary: invoice.cleared
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/WebhookDelivery'
+      responses:
+        '200':
+          description: Received
+        '410':
+          description: Gone — unsubscribes
+  invoice.rejected:
+    post:
+      operationId: erpWebhookInvoiceRejected
+      summary: invoice.rejected
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/WebhookDelivery'
+      responses:
+        '200':
+          description: Received
+        '410':
+          description: Gone — unsubscribes
+  credit_note.issued:
+    post:
+      operationId: erpWebhookCreditNoteIssued
+      summary: credit_note.issued
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/WebhookDelivery'
+      responses:
+        '200':
+          description: Received
+        '410':
+          description: Gone — unsubscribes
+  payment.received:
+    post:
+      operationId: erpWebhookPaymentReceived
+      summary: payment.received
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/WebhookDelivery'
+      responses:
+        '200':
+          description: Received
+        '410':
+          description: Gone — unsubscribes
+  order.confirmed:
+    post:
+      operationId: erpWebhookOrderConfirmed
+      summary: order.confirmed
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/WebhookDelivery'
+      responses:
+        '200':
+          description: Received
+        '410':
+          description: Gone — unsubscribes
+  stock.low:
+    post:
+      operationId: erpWebhookStockLow
+      summary: stock.low
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/WebhookDelivery'
+      responses:
+        '200':
+          description: Received
+        '410':
+          description: Gone — unsubscribes
+  po.confirmed_by_supplier:
+    post:
+      operationId: erpWebhookPoConfirmedBySupplier
+      summary: po.confirmed_by_supplier
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/WebhookDelivery'
+      responses:
+        '200':
+          description: Received
+        '410':
+          description: Gone — unsubscribes
+  expense.posted:
+    post:
+      operationId: erpWebhookExpensePosted
+      summary: expense.posted
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/WebhookDelivery'
+      responses:
+        '200':
+          description: Received
+        '410':
+          description: Gone — unsubscribes
+components:
+  securitySchemes:
+    zapierApiKey:
+      type: apiKey
+      in: header
+      name: X-Zapier-Api-Key
+  parameters:
+    Page:
+      name: page
+      in: query
+      required: false
+      description: Page (1-based)
+      schema:
+        type: integer
+        minimum: 1
+    PerPage:
+      name: per_page
+      in: query
+      required: false
+      description: 1–100 (default 25)
+      schema:
+        type: integer
+        minimum: 1
+        maximum: 100
+    UpdatedSince:
+      name: updated_since
+      in: query
+      required: false
+      description: ISO-8601
+      schema:
+        type: string
+        format: date-time
+    CreatedSince:
+      name: created_since
+      in: query
+      required: false
+      description: ISO-8601
+      schema:
+        type: string
+        format: date-time
+    Sort:
+      name: sort
+      in: query
+      required: false
+      description: Sort key (per endpoint)
+      schema:
+        type: string
+    Dir:
+      name: dir
+      in: query
+      required: false
+      description: asc|desc
+      schema:
+        type: string
+        enum:
+        - asc
+        - desc
+    IdempotencyKey:
+      name: Idempotency-Key
+      in: header
+      required: false
+      description: Optional. Same key + same body within 24 h replays the first answer; same key + another body → 422 idempotency_key_reused.
+      schema:
+        type: string
+        maxLength: 255
+  responses:
+    Unauthorized:
+      description: Missing or invalid API key
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+    MissingScope:
+      description: The key does not list the `erp` scope
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+    NotFound:
+      description: Unknown record, or the area is not switched on for this workspace
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+    Unprocessable:
+      description: Validation failed or the ERP engine refused (code = reason)
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+    TooManyRequests:
+      description: Rate limit
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+  schemas:
+    Error:
+      type: object
+      required:
+      - success
+      - error
+      - code
+      properties:
+        success:
+          const: false
+        error:
+          type: string
+          description: Human message that states the fix.
+        code:
+          type: string
+          description: 'Machine code: not_found, missing_scope, validation_failed, idempotency_key_reused, idempotency_request_in_progress, or the ERP engine reason (e.g. credit_limit_exceeded, buyer_incomplete,
+            insufficient_available, variant_unknown, supplier_required, vat_exceeds_amount).'
+        errors:
+          type: object
+          additionalProperties:
+            type: array
+            items:
+              type: string
+        params:
+          type: object
+          additionalProperties: true
+    PageMeta:
+      type: object
+      properties:
+        current_page: *id013
+        last_page: *id013
+        per_page: *id013
+        total: *id013
+    Money: &id018
+      type: string
+      pattern: ^-?\d+\.\d{4}$
+      example: '1150.0000'
+    Item:
+      type: object
+      properties:
+        id: *id013
+        sku: &id017
+          type:
+          - string
+          - 'null'
+        name:
+          type: string
+        name_en: *id017
+        type:
+          type: string
+          enum:
+          - stock
+          - service
+          - kit
+          - consumable
+        category_id: &id019
+          type:
+          - integer
+          - 'null'
+        sale_price: *id018
+        price_includes_tax:
+          type: boolean
+        currency: *id017
+        tracking:
+          type: string
+        has_expiry:
+          type: boolean
+        crm_product_id: *id019
+        status:
+          type: string
+        created_at: &id020
+          type:
+          - string
+          - 'null'
+          format: date-time
+        updated_at: *id020
+        variants:
+          type: array
+          items:
+            $ref: '#/components/schemas/Variant'
+    Variant:
+      type: object
+      properties:
+        id: *id013
+        item_id: *id013
+        sku: *id017
+        name: *id017
+        option_values: {}
+        sale_price: *id018
+        is_default:
+          type: boolean
+        status:
+          type: string
+        item:
+          type: object
+    Warehouse:
+      type: object
+      properties:
+        id: *id013
+        code:
+          type: string
+        name:
+          type: string
+        name_en: *id017
+        kind:
+          type: string
+        is_sellable:
+          type: boolean
+        is_channel_default:
+          type: boolean
+        branch_id: *id019
+        status:
+          type: string
+    StockLevel:
+      type: object
+      properties:
+        variant_id: *id013
+        sku: *id017
+        warehouse_id: *id013
+        warehouse_code:
+          type: string
+        warehouse_sellable:
+          type: boolean
+        on_hand: *id018
+        reserved: *id018
+        available: *id018
+        updated_at: *id020
+    StockMove:
+      type: object
+      description: Append-only ledger row (never cost).
+      properties:
+        id: *id013
+        moved_at: *id020
+        variant_id: *id013
+        warehouse_id: *id013
+        lot_id: *id019
+        qty: *id018
+        qty_after_warehouse:
+          type:
+          - string
+          - 'null'
+        move_type:
+          type: string
+        document_type: *id017
+        document_id: *id019
+        document_number: *id017
+        reason_code: *id017
+        group_uid: *id017
+        reverses_move_id: *id019
+        source: *id017
+    Customer:
+      type: object
+      properties:
+        id: *id013
+        contact_id: *id019
+        company_id: *id019
+        party_type: *id017
+        display_name: *id017
+        legal_name: *id017
+        legal_name_en: *id017
+        vat_number: *id017
+        cr_number: *id017
+        address:
+          type:
+          - object
+          - 'null'
+        credit_limit:
+          type:
+          - string
+          - 'null'
+        payment_terms_days: *id019
+        currency: *id017
+        tax_exempt:
+          type: boolean
+        archived:
+          type: boolean
+        created_at: *id020
+        updated_at: *id020
+    Statement:
+      type: object
+      properties:
+        customer:
+          $ref: '#/components/schemas/Customer'
+        from:
+          type: string
+          format: date
+        to:
+          type: string
+          format: date
+        currencies:
+          type: array
+          items:
+            type: object
+            properties:
+              currency:
+                type: string
+              opening: *id018
+              closing: *id018
+              debit: *id018
+              credit: *id018
+              rows:
+                type: array
+                items:
+                  type: object
+        pdf_url:
+          type:
+          - string
+          - 'null'
+          format: uri
+    SalesOrder:
+      type: object
+      properties:
+        id: *id013
+        number: *id017
+        status:
+          type: string
+          enum:
+          - draft
+          - confirmed
+          - partially_delivered
+          - delivered
+          - invoiced
+          - closed
+          - cancelled
+        delivery_status: *id017
+        invoice_status: *id017
+        review_status: *id017
+        source: *id017
+        customer_id: *id019
+        contact_id: *id019
+        company_id: *id019
+        deal_id: *id019
+        warehouse_id: *id019
+        currency:
+          type: string
+        prices_include_tax:
+          type: boolean
+        subtotal: *id018
+        discount_total: *id018
+        tax_total: *id018
+        total: *id018
+        payment_method: *id017
+        payment_terms_days: *id019
+        delivery_date: &id021
+          type:
+          - string
+          - 'null'
+          format: date
+        notes: *id017
+        confirmed_at: *id020
+        cancelled_at: *id020
+        created_at: *id020
+        updated_at: *id020
+        lines:
+          type:
+          - array
+          - 'null'
+          items:
+            type: object
+    Invoice:
+      type: object
+      description: Invoice, simplified invoice, debit note or credit note.
+      properties:
+        id: *id013
+        number: *id017
+        doc_type:
+          type: string
+          enum:
+          - tax
+          - simplified
+          - credit_note
+          - debit_note
+        status:
+          type: string
+        einvoice_status:
+          type: string
+          description: not_required, pending, cleared, reported, warning, rejected, failed (ZATCA) / ETA states.
+        order_id: *id019
+        original_invoice_id: *id019
+        adjustment_reason: *id017
+        customer_id: *id019
+        contact_id: *id019
+        company_id: *id019
+        deal_id: *id019
+        buyer:
+          type:
+          - object
+          - 'null'
+        currency:
+          type: string
+        issue_date: *id021
+        supply_date: *id021
+        due_date: *id021
+        prices_include_tax:
+          type: boolean
+        subtotal: *id018
+        discount_total: *id018
+        tax_total: *id018
+        total: *id018
+        amount_paid: *id018
+        amount_credited: *id018
+        balance_due: *id018
+        uuid: *id017
+        share_blocked_reason: *id017
+        issued_at: *id020
+        created_at: *id020
+        updated_at: *id020
+        lines:
+          type:
+          - array
+          - 'null'
+          items:
+            type: object
+    InvoiceLinks:
+      type: object
+      properties:
+        id: *id013
+        number: *id017
+        available:
+          type: boolean
+        blocked_reason:
+          type:
+          - string
+          - 'null'
+          description: not_issued, einvoice_pending, … — the link appears once the invoice may be shared.
+        pdf_url:
+          type:
+          - string
+          - 'null'
+          format: uri
+        page_url:
+          type:
+          - string
+          - 'null'
+          format: uri
+    Payment:
+      type: object
+      properties:
+        id: *id013
+        number: *id017
+        direction:
+          type: string
+          enum:
+          - in
+          - out
+        method:
+          type: string
+        status:
+          type: string
+        source: *id017
+        customer_id: *id019
+        contact_id: *id019
+        amount: *id018
+        allocated: *id018
+        unallocated: *id018
+        currency:
+          type: string
+        received_at: *id020
+        provider: *id017
+        provider_payment_id: *id017
+        reference: *id017
+        reverses_payment_id: *id019
+        allocations:
+          type:
+          - array
+          - 'null'
+          items:
+            type: object
+            properties:
+              kind:
+                type: string
+              invoice_id: *id019
+              credit_note_id: *id019
+              amount: *id018
+        created_at: *id020
+    Supplier:
+      type: object
+      properties:
+        id: *id013
+        code: *id017
+        name:
+          type: string
+        legal_name: *id017
+        legal_name_en: *id017
+        contact_id: *id019
+        company_id: *id019
+        vat_number: *id017
+        cr_number: *id017
+        address:
+          type:
+          - object
+          - 'null'
+        whatsapp_phone: *id017
+        email: *id017
+        currency: *id017
+        payment_terms_days: *id019
+        lead_time_days: *id019
+        status:
+          type: string
+        created_at: *id020
+        updated_at: *id020
+    PurchaseOrder:
+      type: object
+      properties:
+        id: *id013
+        number: *id017
+        status:
+          type: string
+        approval_status: *id017
+        receipt_status: *id017
+        billing_status: *id017
+        supplier_reply: *id017
+        supplier_reply_at: *id020
+        supplier_id: *id013
+        warehouse_id: *id019
+        order_date: *id021
+        expected_date: *id021
+        payment_terms_days: *id019
+        currency:
+          type: string
+        subtotal: *id018
+        tax_total: *id018
+        total: *id018
+        source: *id017
+        notes: *id017
+        sent_at: *id020
+        created_at: *id020
+        updated_at: *id020
+        lines:
+          type:
+          - array
+          - 'null'
+          items:
+            type: object
+    Bill:
+      type: object
+      properties:
+        id: *id013
+        number: *id017
+        status:
+          type: string
+        kind:
+          type: string
+        supplier_id: *id013
+        purchase_order_id: *id019
+        supplier_invoice_no: *id017
+        bill_date: *id021
+        due_date: *id021
+        currency:
+          type: string
+        subtotal: *id018
+        tax_total: *id018
+        total: *id018
+        amount_paid: *id018
+        balance_due: *id018
+        match_status: *id017
+        posted_at: *id020
+        created_at: *id020
+        updated_at: *id020
+        lines:
+          type:
+          - array
+          - 'null'
+          items:
+            type: object
+    Expense:
+      type: object
+      properties:
+        id: *id013
+        number: *id017
+        status:
+          type: string
+          enum:
+          - draft
+          - pending_approval
+          - posted
+          - rejected
+          - void
+        source: *id017
+        expense_date: *id021
+        category_id: *id019
+        category_code: *id017
+        description: *id017
+        vendor_name: *id017
+        vendor_vat_number: *id017
+        supplier_id: *id019
+        receipt_number: *id017
+        is_tax_invoice:
+          type: boolean
+        currency:
+          type: string
+        amount:
+          type:
+          - string
+          - 'null'
+        vat_amount: *id018
+        net_amount:
+          type:
+          - string
+          - 'null'
+        vat_recoverable:
+          type: boolean
+        paid_from: *id017
+        branch_id: *id019
+        journal_entry_id: *id019
+        notes: *id017
+        approved_at: *id020
+        created_at: *id020
+        updated_at: *id020
+    ExpenseCategory:
+      type: object
+      properties:
+        id: *id013
+        code:
+          type: string
+        name:
+          type: string
+        name_en: *id017
+        parent_id: *id019
+        vat_applicable:
+          type: boolean
+    Account:
+      type: object
+      properties:
+        id: *id013
+        code:
+          type: string
+        name:
+          type: string
+        name_en: *id017
+        type:
+          type: string
+        subtype: *id017
+        parent_id: *id019
+        is_group:
+          type: boolean
+        currency: *id017
+        is_active:
+          type: boolean
+    JournalEntry:
+      type: object
+      description: Append-only; corrections are reversing entries.
+      properties:
+        id: *id013
+        number: *id017
+        entry_date: *id021
+        kind: *id017
+        status: *id017
+        rule: *id017
+        document_type: *id017
+        document_id: *id019
+        document_number: *id017
+        reverses_entry_id: *id019
+        reversed_by_entry_id: *id019
+        currency: *id017
+        total_debit: *id018
+        total_credit: *id018
+        memo: *id017
+        source: *id017
+        posted_at: *id020
+        lines:
+          type:
+          - array
+          - 'null'
+          items:
+            type: object
+    Report:
+      type: object
+      additionalProperties: true
+      description: Report body as built by the accounting engine (sections, rows, totals as 4-dp strings).
+    Hook:
+      type: object
+      properties:
+        id: *id013
+        url:
+          type: string
+        events:
+          type: array
+          items:
+            type: string
+        source:
+          type: string
+        description: *id017
+        is_active:
+          type: boolean
+        disabled_reason: *id017
+        created_at: *id020
+        secret:
+          type: string
+          description: whsec_… — only in the subscribe answer; signs every delivery.
+    HookEvent:
+      type: object
+      properties:
+        event:
+          type: string
+          enum:
+          - invoice.issued
+          - invoice.paid
+          - invoice.cleared
+          - invoice.rejected
+          - credit_note.issued
+          - payment.received
+          - order.confirmed
+          - stock.low
+          - po.confirmed_by_supplier
+          - expense.posted
+        object:
+          type: string
+        area:
+          type: string
+        available:
+          type: boolean
+    WebhookDelivery:
+      type: object
+      description: 'Body POSTed to the subscriber. Headers: X-LetsBot-Event, X-LetsBot-Delivery, X-LetsBot-Signature: t=<unix>,v1=<hex HMAC-SHA256 of "<t>.<body>" with the subscription secret>. Answer 2xx;
+        410 unsubscribes.'
+      properties:
+        id:
+          type: string
+        event:
+          type: string
+        object:
+          type: string
+        record_id: *id019
+        occurred_at:
+          type: string
+          format: date-time
+        data:
+          type: object
+        previous:
+          type: object
+    LineIn:
+      type: object
+      required:
+      - qty
+      description: variant_id or sku (inventory), crm_product_id, or free text name + unit_price. Client totals are ignored.
+      properties:
+        variant_id: *id013
+        sku:
+          type: string
+        crm_product_id: *id013
+        name:
+          type: string
+        name_en:
+          type: string
+        description:
+          type: string
+        qty:
+          type: number
+          exclusiveMinimum: 0
+        unit_price:
+          type: number
+          minimum: 0
+        discount_pct:
+          type: number
+        discount_amount:
+          type: number
+        tax_rate:
+          type: number