m3ter API — BalanceTransactionSchedule

naftiko: 1.0.0-alpha2
info:
  label: m3ter API — BalanceTransactionSchedule
  description: 'm3ter API — BalanceTransactionSchedule. 6 operations. Lead operation: List BalanceTransactionSchedule. Self-contained
    Naftiko capability covering one M3ter business surface.'
  tags:
  - M3ter
  - BalanceTransactionSchedule
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    M3TER_API_KEY: M3TER_API_KEY
capability:
  consumes:
  - type: http
    namespace: m3ter-balancetransactionschedule
    baseUri: https://api.m3ter.com
    description: m3ter API — BalanceTransactionSchedule business capability. Self-contained, no shared references.
    resources:
    - name: organizations-orgId-balances-balanceId-balancetransactionschedules
      path: /organizations/{orgId}/balances/{balanceId}/balancetransactionschedules
      operations:
      - name: listbalancetransactionschedule
        method: GET
        description: List BalanceTransactionSchedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: UUID of the organization
          required: true
        - name: balanceId
          in: path
          type: string
          description: UUID of the balance
          required: true
        - name: pageSize
          in: query
          type: integer
          description: Number of BalanceTransactionSchedules to retrieve per page
        - name: nextToken
          in: query
          type: string
          description: nextToken for multi page retrievals
        - name: ids
          in: query
          type: array
      - name: createbalancetransactionschedule
        method: POST
        description: Create BalanceTransactionSchedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: UUID of the organization
          required: true
        - name: balanceId
          in: path
          type: string
          description: UUID of the balance
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-orgId-balances-balanceId-balancetransactionschedules-preview
      path: /organizations/{orgId}/balances/{balanceId}/balancetransactionschedules/preview
      operations:
      - name: previewbalancetransactionschedule
        method: POST
        description: Preview ScheduledBalanceTransactions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: UUID of the organization
          required: true
        - name: balanceId
          in: path
          type: string
          description: UUID of the balance
          required: true
        - name: pageSize
          in: query
          type: integer
          description: Number of BalanceTransactions to retrieve per page
        - name: nextToken
          in: query
          type: string
          description: nextToken for multi page retrievals
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-orgId-balances-balanceId-balancetransactionschedules-id
      path: /organizations/{orgId}/balances/{balanceId}/balancetransactionschedules/{id}
      operations:
      - name: getbalancetransactionschedule
        method: GET
        description: Retrieve BalanceTransactionSchedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: UUID of the organization
          required: true
        - name: balanceId
          in: path
          type: string
          description: UUID of the balance
          required: true
        - name: id
          in: path
          type: string
          description: The UUID of the BalanceTransactionSchedule to retrieve.
          required: true
      - name: updatebalancetransactionschedule
        method: PUT
        description: Update BalanceTransactionSchedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: UUID of the organization
          required: true
        - name: balanceId
          in: path
          type: string
          description: UUID of the balance
          required: true
        - name: id
          in: path
          type: string
          description: The UUID of the BalanceTransactionSchedule to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletebalancetransactionschedule
        method: DELETE
        description: Delete BalanceTransactionSchedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: UUID of the organization
          required: true
        - name: balanceId
          in: path
          type: string
          description: UUID of the balance
          required: true
        - name: id
          in: path
          type: string
          description: The UUID of the BalanceTransactionSchedule to update.
          required: true
    authentication:
      type: bearer
      token: '{{env.M3TER_API_KEY}}'
  exposes:
  - type: rest
    namespace: m3ter-balancetransactionschedule-rest
    port: 8080
    description: REST adapter for m3ter API — BalanceTransactionSchedule. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/organizations/{orgid}/balances/{balanceid}/balancetransactionschedules
      name: organizations-orgid-balances-balanceid-balancetransactionschedules
      description: REST surface for organizations-orgId-balances-balanceId-balancetransactionschedules.
      operations:
      - method: GET
        name: listbalancetransactionschedule
        description: List BalanceTransactionSchedule
        call: m3ter-balancetransactionschedule.listbalancetransactionschedule
        with:
          orgId: rest.orgId
          balanceId: rest.balanceId
          pageSize: rest.pageSize
          nextToken: rest.nextToken
          ids: rest.ids
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createbalancetransactionschedule
        description: Create BalanceTransactionSchedule
        call: m3ter-balancetransactionschedule.createbalancetransactionschedule
        with:
          orgId: rest.orgId
          balanceId: rest.balanceId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{orgid}/balances/{balanceid}/balancetransactionschedules/preview
      name: organizations-orgid-balances-balanceid-balancetransactionschedules-preview
      description: REST surface for organizations-orgId-balances-balanceId-balancetransactionschedules-preview.
      operations:
      - method: POST
        name: previewbalancetransactionschedule
        description: Preview ScheduledBalanceTransactions
        call: m3ter-balancetransactionschedule.previewbalancetransactionschedule
        with:
          orgId: rest.orgId
          balanceId: rest.balanceId
          pageSize: rest.pageSize
          nextToken: rest.nextToken
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{orgid}/balances/{balanceid}/balancetransactionschedules/{id}
      name: organizations-orgid-balances-balanceid-balancetransactionschedules-id
      description: REST surface for organizations-orgId-balances-balanceId-balancetransactionschedules-id.
      operations:
      - method: GET
        name: getbalancetransactionschedule
        description: Retrieve BalanceTransactionSchedule
        call: m3ter-balancetransactionschedule.getbalancetransactionschedule
        with:
          orgId: rest.orgId
          balanceId: rest.balanceId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatebalancetransactionschedule
        description: Update BalanceTransactionSchedule
        call: m3ter-balancetransactionschedule.updatebalancetransactionschedule
        with:
          orgId: rest.orgId
          balanceId: rest.balanceId
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletebalancetransactionschedule
        description: Delete BalanceTransactionSchedule
        call: m3ter-balancetransactionschedule.deletebalancetransactionschedule
        with:
          orgId: rest.orgId
          balanceId: rest.balanceId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: m3ter-balancetransactionschedule-mcp
    port: 9090
    transport: http
    description: MCP adapter for m3ter API — BalanceTransactionSchedule. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-balancetransactionschedule
      description: List BalanceTransactionSchedule
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-balancetransactionschedule.listbalancetransactionschedule
      with:
        orgId: tools.orgId
        balanceId: tools.balanceId
        pageSize: tools.pageSize
        nextToken: tools.nextToken
        ids: tools.ids
      outputParameters:
      - type: object
        mapping: $.
    - name: create-balancetransactionschedule
      description: Create BalanceTransactionSchedule
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: m3ter-balancetransactionschedule.createbalancetransactionschedule
      with:
        orgId: tools.orgId
        balanceId: tools.balanceId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: preview-scheduledbalancetransactions
      description: Preview ScheduledBalanceTransactions
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: m3ter-balancetransactionschedule.previewbalancetransactionschedule
      with:
        orgId: tools.orgId
        balanceId: tools.balanceId
        pageSize: tools.pageSize
        nextToken: tools.nextToken
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-balancetransactionschedule
      description: Retrieve BalanceTransactionSchedule
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-balancetransactionschedule.getbalancetransactionschedule
      with:
        orgId: tools.orgId
        balanceId: tools.balanceId
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-balancetransactionschedule
      description: Update BalanceTransactionSchedule
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: m3ter-balancetransactionschedule.updatebalancetransactionschedule
      with:
        orgId: tools.orgId
        balanceId: tools.balanceId
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-balancetransactionschedule
      description: Delete BalanceTransactionSchedule
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: m3ter-balancetransactionschedule.deletebalancetransactionschedule
      with:
        orgId: tools.orgId
        balanceId: tools.balanceId
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.