naftiko: 1.0.0-alpha2
info:
  label: API Reference — Invoice Schedules
  description: 'API Reference — Invoice Schedules. 7 operations. Lead operation: Create an invoice schedule. Self-contained
    Naftiko capability covering one Zuora business surface.'
  tags:
  - Zuora
  - Invoice Schedules
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZUORA_API_KEY: ZUORA_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-invoice-schedules
    baseUri: https://rest.zuora.com
    description: API Reference — Invoice Schedules business capability. Self-contained, no shared references.
    resources:
    - name: v1-invoice-schedules
      path: /v1/invoice-schedules
      operations:
      - name: postcreateinvoiceschedule
        method: POST
        description: Create an invoice schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Request
          in: body
          type: string
          required: true
    - name: v1-invoice-schedules-scheduleKey
      path: /v1/invoice-schedules/{scheduleKey}
      operations:
      - name: putupdateinvoiceschedule
        method: PUT
        description: Update an invoice schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: scheduleKey
          in: path
          type: string
          description: The unique ID or number of the invoice schedule to be updated. For example, 2c92c8955bd63cc1015bd7c151af02ab
            or IS-0000001.
          required: true
        - name: Request
          in: body
          type: string
          required: true
      - name: getinvoiceschedule
        method: GET
        description: Retrieve an invoice schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: scheduleKey
          in: path
          type: string
          description: The unique ID or number of the invoice schedule to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab
            or IS-0000001.
          required: true
      - name: deleteinvoiceschedule
        method: DELETE
        description: Delete an invoice schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: scheduleKey
          in: path
          type: string
          description: The unique ID or number of the invoice schedule to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab
            or IS-0000001.
          required: true
    - name: v1-invoice-schedules-scheduleKey-execute
      path: /v1/invoice-schedules/{scheduleKey}/execute
      operations:
      - name: postexecuteinvoiceschedule
        method: POST
        description: Execute an invoice schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: scheduleKey
          in: path
          type: string
          description: The unique ID or number of the schedule to be executed. For example, 2c92c8955bd63cc1015bd7c151af02ab
            or IS-0000001.
          required: true
        - name: Request
          in: body
          type: string
          required: true
    - name: v1-invoice-schedules-scheduleKey-pause
      path: /v1/invoice-schedules/{scheduleKey}/pause
      operations:
      - name: putpauseinvoiceschedule
        method: PUT
        description: Pause an invoice schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: scheduleKey
          in: path
          type: string
          description: The unique ID or number of the schedule to be paused. For example, 2c92c8955bd63cc1015bd7c151af02ab
            or IS-0000001.
          required: true
    - name: v1-invoice-schedules-scheduleKey-resume
      path: /v1/invoice-schedules/{scheduleKey}/resume
      operations:
      - name: putresumeinvoiceschedule
        method: PUT
        description: Resume an invoice schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: scheduleKey
          in: path
          type: string
          description: The unique ID or number of the schedule to be resumed. For example, 2c92c8955bd63cc1015bd7c151af02ab
            or IS-0000001.
          required: true
  exposes:
  - type: rest
    namespace: v1-invoice-schedules-rest
    port: 8080
    description: REST adapter for API Reference — Invoice Schedules. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/invoice-schedules
      name: v1-invoice-schedules
      description: REST surface for v1-invoice-schedules.
      operations:
      - method: POST
        name: postcreateinvoiceschedule
        description: Create an invoice schedule
        call: v1-invoice-schedules.postcreateinvoiceschedule
        with:
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/invoice-schedules/{schedulekey}
      name: v1-invoice-schedules-schedulekey
      description: REST surface for v1-invoice-schedules-scheduleKey.
      operations:
      - method: PUT
        name: putupdateinvoiceschedule
        description: Update an invoice schedule
        call: v1-invoice-schedules.putupdateinvoiceschedule
        with:
          scheduleKey: rest.scheduleKey
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getinvoiceschedule
        description: Retrieve an invoice schedule
        call: v1-invoice-schedules.getinvoiceschedule
        with:
          scheduleKey: rest.scheduleKey
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteinvoiceschedule
        description: Delete an invoice schedule
        call: v1-invoice-schedules.deleteinvoiceschedule
        with:
          scheduleKey: rest.scheduleKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/invoice-schedules/{schedulekey}/execute
      name: v1-invoice-schedules-schedulekey-execute
      description: REST surface for v1-invoice-schedules-scheduleKey-execute.
      operations:
      - method: POST
        name: postexecuteinvoiceschedule
        description: Execute an invoice schedule
        call: v1-invoice-schedules.postexecuteinvoiceschedule
        with:
          scheduleKey: rest.scheduleKey
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/invoice-schedules/{schedulekey}/pause
      name: v1-invoice-schedules-schedulekey-pause
      description: REST surface for v1-invoice-schedules-scheduleKey-pause.
      operations:
      - method: PUT
        name: putpauseinvoiceschedule
        description: Pause an invoice schedule
        call: v1-invoice-schedules.putpauseinvoiceschedule
        with:
          scheduleKey: rest.scheduleKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/invoice-schedules/{schedulekey}/resume
      name: v1-invoice-schedules-schedulekey-resume
      description: REST surface for v1-invoice-schedules-scheduleKey-resume.
      operations:
      - method: PUT
        name: putresumeinvoiceschedule
        description: Resume an invoice schedule
        call: v1-invoice-schedules.putresumeinvoiceschedule
        with:
          scheduleKey: rest.scheduleKey
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-invoice-schedules-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — Invoice Schedules. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: create-invoice-schedule
      description: Create an invoice schedule
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-invoice-schedules.postcreateinvoiceschedule
      with:
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: update-invoice-schedule
      description: Update an invoice schedule
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-invoice-schedules.putupdateinvoiceschedule
      with:
        scheduleKey: tools.scheduleKey
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-invoice-schedule
      description: Retrieve an invoice schedule
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-invoice-schedules.getinvoiceschedule
      with:
        scheduleKey: tools.scheduleKey
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-invoice-schedule
      description: Delete an invoice schedule
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v1-invoice-schedules.deleteinvoiceschedule
      with:
        scheduleKey: tools.scheduleKey
      outputParameters:
      - type: object
        mapping: $.
    - name: execute-invoice-schedule
      description: Execute an invoice schedule
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-invoice-schedules.postexecuteinvoiceschedule
      with:
        scheduleKey: tools.scheduleKey
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: pause-invoice-schedule
      description: Pause an invoice schedule
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-invoice-schedules.putpauseinvoiceschedule
      with:
        scheduleKey: tools.scheduleKey
      outputParameters:
      - type: object
        mapping: $.
    - name: resume-invoice-schedule
      description: Resume an invoice schedule
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-invoice-schedules.putresumeinvoiceschedule
      with:
        scheduleKey: tools.scheduleKey
      outputParameters:
      - type: object
        mapping: $.