API Reference — Journal Runs

naftiko: 1.0.0-alpha2
info:
  label: API Reference — Journal Runs
  description: 'API Reference — Journal Runs. 4 operations. Lead operation: Create a journal run. Self-contained Naftiko capability
    covering one Zuora business surface.'
  tags:
  - Zuora
  - Journal Runs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZUORA_API_KEY: ZUORA_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-journal-runs
    baseUri: https://rest.zuora.com
    description: API Reference — Journal Runs business capability. Self-contained, no shared references.
    resources:
    - name: v1-journal-runs
      path: /v1/journal-runs
      operations:
      - name: postjournalrun
        method: POST
        description: Create a journal run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Request
          in: body
          type: string
          required: true
    - name: v1-journal-runs-jr-number
      path: /v1/journal-runs/{jr-number}
      operations:
      - name: getjournalrun
        method: GET
        description: Retrieve a journal run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jr-number
          in: path
          type: string
          description: Journal run number. Must be a valid journal run number in the format `JR-00000001`.
          required: true
      - name: deletejournalrun
        method: DELETE
        description: Delete a journal run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jr-number
          in: path
          type: string
          description: Journal run number. Must be a valid journal run number in the format `JR-00000001`.
          required: true
    - name: v1-journal-runs-jr-number-cancel
      path: /v1/journal-runs/{jr-number}/cancel
      operations:
      - name: putjournalrun
        method: PUT
        description: Cancel a journal run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jr-number
          in: path
          type: string
          description: 'Journal run number. Must be a valid journal run number in the format JR-00000001. '
          required: true
  exposes:
  - type: rest
    namespace: v1-journal-runs-rest
    port: 8080
    description: REST adapter for API Reference — Journal Runs. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/journal-runs
      name: v1-journal-runs
      description: REST surface for v1-journal-runs.
      operations:
      - method: POST
        name: postjournalrun
        description: Create a journal run
        call: v1-journal-runs.postjournalrun
        with:
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/journal-runs/{jr-number}
      name: v1-journal-runs-jr-number
      description: REST surface for v1-journal-runs-jr-number.
      operations:
      - method: GET
        name: getjournalrun
        description: Retrieve a journal run
        call: v1-journal-runs.getjournalrun
        with:
          jr-number: rest.jr-number
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletejournalrun
        description: Delete a journal run
        call: v1-journal-runs.deletejournalrun
        with:
          jr-number: rest.jr-number
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/journal-runs/{jr-number}/cancel
      name: v1-journal-runs-jr-number-cancel
      description: REST surface for v1-journal-runs-jr-number-cancel.
      operations:
      - method: PUT
        name: putjournalrun
        description: Cancel a journal run
        call: v1-journal-runs.putjournalrun
        with:
          jr-number: rest.jr-number
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-journal-runs-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — Journal Runs. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: create-journal-run
      description: Create a journal run
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-journal-runs.postjournalrun
      with:
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-journal-run
      description: Retrieve a journal run
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-journal-runs.getjournalrun
      with:
        jr-number: tools.jr-number
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-journal-run
      description: Delete a journal run
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v1-journal-runs.deletejournalrun
      with:
        jr-number: tools.jr-number
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-journal-run
      description: Cancel a journal run
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-journal-runs.putjournalrun
      with:
        jr-number: tools.jr-number
      outputParameters:
      - type: object
        mapping: $.