API Reference — Operations

naftiko: 1.0.0-alpha2
info:
  label: API Reference — Operations
  description: 'API Reference — Operations. 3 operations. Lead operation: Generate a billing preview. Self-contained Naftiko
    capability covering one Zuora business surface.'
  tags:
  - Zuora
  - Operations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZUORA_API_KEY: ZUORA_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-operations
    baseUri: https://rest.zuora.com
    description: API Reference — Operations business capability. Self-contained, no shared references.
    resources:
    - name: v1-operations-billing-preview
      path: /v1/operations/billing-preview
      operations:
      - name: postbillingpreview
        method: POST
        description: Generate a billing preview
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Request
          in: body
          type: string
          required: true
    - name: v1-operations-invoice-collect
      path: /v1/operations/invoice-collect
      operations:
      - name: posttransactioninvoicepayment
        method: POST
        description: Invoice and collect
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: zuora-version
          in: header
          type: string
          description: 'The minor version of the Zuora REST API. '
        - name: Request
          in: body
          type: string
          required: true
    - name: v1-operations-jobs-jobId
      path: /v1/operations/jobs/{jobId}
      operations:
      - name: getoperationjob
        method: GET
        description: Retrieve an operation job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobId
          in: path
          type: string
          description: The ID of the operation job to retrieve information about. For example, 2c92c8955bd63cc1015bd7c151af02ab.
          required: true
  exposes:
  - type: rest
    namespace: v1-operations-rest
    port: 8080
    description: REST adapter for API Reference — Operations. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/operations/billing-preview
      name: v1-operations-billing-preview
      description: REST surface for v1-operations-billing-preview.
      operations:
      - method: POST
        name: postbillingpreview
        description: Generate a billing preview
        call: v1-operations.postbillingpreview
        with:
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/operations/invoice-collect
      name: v1-operations-invoice-collect
      description: REST surface for v1-operations-invoice-collect.
      operations:
      - method: POST
        name: posttransactioninvoicepayment
        description: Invoice and collect
        call: v1-operations.posttransactioninvoicepayment
        with:
          zuora-version: rest.zuora-version
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/operations/jobs/{jobid}
      name: v1-operations-jobs-jobid
      description: REST surface for v1-operations-jobs-jobId.
      operations:
      - method: GET
        name: getoperationjob
        description: Retrieve an operation job
        call: v1-operations.getoperationjob
        with:
          jobId: rest.jobId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-operations-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — Operations. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: generate-billing-preview
      description: Generate a billing preview
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-operations.postbillingpreview
      with:
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: invoice-and-collect
      description: Invoice and collect
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-operations.posttransactioninvoicepayment
      with:
        zuora-version: tools.zuora-version
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-operation-job
      description: Retrieve an operation job
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-operations.getoperationjob
      with:
        jobId: tools.jobId
      outputParameters:
      - type: object
        mapping: $.