API Reference — Summary Journal Entries

naftiko: 1.0.0-alpha2
info:
  label: API Reference — Summary Journal Entries
  description: 'API Reference — Summary Journal Entries. 6 operations. Lead operation: Create a summary journal entry. Self-contained
    Naftiko capability covering one Zuora business surface.'
  tags:
  - Zuora
  - Summary Journal Entries
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZUORA_API_KEY: ZUORA_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-summary-journal-entries
    baseUri: https://rest.zuora.com
    description: API Reference — Summary Journal Entries business capability. Self-contained, no shared references.
    resources:
    - name: v1-journal-entries
      path: /v1/journal-entries
      operations:
      - name: postsummaryjournalentry
        method: POST
        description: Create a summary journal entry
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Request
          in: body
          type: string
          required: true
    - name: v1-journal-entries-journal-runs-jr-number
      path: /v1/journal-entries/journal-runs/{jr-number}
      operations:
      - name: getallsummaryjournalentries
        method: GET
        description: List all summary journal entries in a journal run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jr-number
          in: path
          type: string
          description: Journal run number.
          required: true
    - name: v1-journal-entries-je-number
      path: /v1/journal-entries/{je-number}
      operations:
      - name: getsummaryjournalentry
        method: GET
        description: Retrieve a summary journal entry
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: je-number
          in: path
          type: string
          required: true
      - name: deletesummaryjournalentry
        method: DELETE
        description: Delete a summary journal entry
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: je-number
          in: path
          type: string
          description: Journal entry number in the format JE-00000001.
          required: true
    - name: v1-journal-entries-je-number-basic-information
      path: /v1/journal-entries/{je-number}/basic-information
      operations:
      - name: putbasicsummaryjournalentry
        method: PUT
        description: Update a summary journal entry
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: je-number
          in: path
          type: string
          description: Journal entry number in the format JE-00000001.
          required: true
        - name: Request
          in: body
          type: string
          required: true
    - name: v1-journal-entries-je-number-cancel
      path: /v1/journal-entries/{je-number}/cancel
      operations:
      - name: putsummaryjournalentry
        method: PUT
        description: Cancel a summary journal entry
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: je-number
          in: path
          type: string
          description: Journal entry number in the format JE-00000001.
          required: true
  exposes:
  - type: rest
    namespace: v1-summary-journal-entries-rest
    port: 8080
    description: REST adapter for API Reference — Summary Journal Entries. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/journal-entries
      name: v1-journal-entries
      description: REST surface for v1-journal-entries.
      operations:
      - method: POST
        name: postsummaryjournalentry
        description: Create a summary journal entry
        call: v1-summary-journal-entries.postsummaryjournalentry
        with:
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/journal-entries/journal-runs/{jr-number}
      name: v1-journal-entries-journal-runs-jr-number
      description: REST surface for v1-journal-entries-journal-runs-jr-number.
      operations:
      - method: GET
        name: getallsummaryjournalentries
        description: List all summary journal entries in a journal run
        call: v1-summary-journal-entries.getallsummaryjournalentries
        with:
          jr-number: rest.jr-number
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/journal-entries/{je-number}
      name: v1-journal-entries-je-number
      description: REST surface for v1-journal-entries-je-number.
      operations:
      - method: GET
        name: getsummaryjournalentry
        description: Retrieve a summary journal entry
        call: v1-summary-journal-entries.getsummaryjournalentry
        with:
          je-number: rest.je-number
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesummaryjournalentry
        description: Delete a summary journal entry
        call: v1-summary-journal-entries.deletesummaryjournalentry
        with:
          je-number: rest.je-number
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/journal-entries/{je-number}/basic-information
      name: v1-journal-entries-je-number-basic-information
      description: REST surface for v1-journal-entries-je-number-basic-information.
      operations:
      - method: PUT
        name: putbasicsummaryjournalentry
        description: Update a summary journal entry
        call: v1-summary-journal-entries.putbasicsummaryjournalentry
        with:
          je-number: rest.je-number
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/journal-entries/{je-number}/cancel
      name: v1-journal-entries-je-number-cancel
      description: REST surface for v1-journal-entries-je-number-cancel.
      operations:
      - method: PUT
        name: putsummaryjournalentry
        description: Cancel a summary journal entry
        call: v1-summary-journal-entries.putsummaryjournalentry
        with:
          je-number: rest.je-number
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-summary-journal-entries-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — Summary Journal Entries. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: create-summary-journal-entry
      description: Create a summary journal entry
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-summary-journal-entries.postsummaryjournalentry
      with:
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-summary-journal-entries
      description: List all summary journal entries in a journal run
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-summary-journal-entries.getallsummaryjournalentries
      with:
        jr-number: tools.jr-number
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-summary-journal-entry
      description: Retrieve a summary journal entry
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-summary-journal-entries.getsummaryjournalentry
      with:
        je-number: tools.je-number
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-summary-journal-entry
      description: Delete a summary journal entry
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v1-summary-journal-entries.deletesummaryjournalentry
      with:
        je-number: tools.je-number
      outputParameters:
      - type: object
        mapping: $.
    - name: update-summary-journal-entry
      description: Update a summary journal entry
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-summary-journal-entries.putbasicsummaryjournalentry
      with:
        je-number: tools.je-number
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-summary-journal-entry
      description: Cancel a summary journal entry
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-summary-journal-entries.putsummaryjournalentry
      with:
        je-number: tools.je-number
      outputParameters:
      - type: object
        mapping: $.