m3ter API — Contract

naftiko: 1.0.0-alpha2
info:
  label: m3ter API — Contract
  description: 'm3ter API — Contract. 6 operations. Lead operation: List Contracts. Self-contained Naftiko capability covering
    one M3ter business surface.'
  tags:
  - M3ter
  - Contract
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    M3TER_API_KEY: M3TER_API_KEY
capability:
  consumes:
  - type: http
    namespace: m3ter-contract
    baseUri: https://api.m3ter.com
    description: m3ter API — Contract business capability. Self-contained, no shared references.
    resources:
    - name: organizations-orgId-contracts
      path: /organizations/{orgId}/contracts
      operations:
      - name: listcontracts
        method: GET
        description: List Contracts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) for your Organization. The Organization represents your company as a direct
            customer of our service.
          required: true
        - name: pageSize
          in: query
          type: integer
          description: Specifies the maximum number of Contracts to retrieve per page.
        - name: nextToken
          in: query
          type: string
          description: The `nextToken` for multi-page retrievals. It is used to fetch the next page of Contracts in a paginated
            list.
        - name: ids
          in: query
          type: array
          description: An optional parameter to filter the list based on specific Contract unique identifiers (UUIDs).
        - name: codes
          in: query
          type: array
          description: An optional parameter to retrieve specific Contracts based on their short codes.
        - name: accountId
          in: query
          type: string
      - name: postcontract
        method: POST
        description: Create Contract
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) for your Organization. The Organization represents your company as a direct
            customer of our service.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-orgId-contracts-id
      path: /organizations/{orgId}/contracts/{id}
      operations:
      - name: getcontract
        method: GET
        description: Retrieve Contract
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
          required: true
        - name: id
          in: path
          type: string
          description: The unique identifier (UUID) of the Contract to retrieve.
          required: true
      - name: putcontract
        method: PUT
        description: Update Contract
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
          required: true
        - name: id
          in: path
          type: string
          description: The unique identifier (UUID) of the Contract to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecontract
        method: DELETE
        description: Delete Contract
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
          required: true
        - name: id
          in: path
          type: string
          description: The unique identifier (UUID) of the Contract to delete.
          required: true
    - name: organizations-orgId-contracts-id-enddatebillingentities
      path: /organizations/{orgId}/contracts/{id}/enddatebillingentities
      operations:
      - name: enddatebillingentitiesforcontract
        method: PUT
        description: End-date Contract Account billing entities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) for your Organization. The Organization represents your company as a direct
            customer of our service.
          required: true
        - name: id
          in: path
          type: string
          description: Unique identifier (UUID) of the Contract - the specified billing entities associated with the Account
            the Contract has been added to will be end-dated.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.M3TER_API_KEY}}'
  exposes:
  - type: rest
    namespace: m3ter-contract-rest
    port: 8080
    description: REST adapter for m3ter API — Contract. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/organizations/{orgid}/contracts
      name: organizations-orgid-contracts
      description: REST surface for organizations-orgId-contracts.
      operations:
      - method: GET
        name: listcontracts
        description: List Contracts
        call: m3ter-contract.listcontracts
        with:
          orgId: rest.orgId
          pageSize: rest.pageSize
          nextToken: rest.nextToken
          ids: rest.ids
          codes: rest.codes
          accountId: rest.accountId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postcontract
        description: Create Contract
        call: m3ter-contract.postcontract
        with:
          orgId: rest.orgId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{orgid}/contracts/{id}
      name: organizations-orgid-contracts-id
      description: REST surface for organizations-orgId-contracts-id.
      operations:
      - method: GET
        name: getcontract
        description: Retrieve Contract
        call: m3ter-contract.getcontract
        with:
          orgId: rest.orgId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putcontract
        description: Update Contract
        call: m3ter-contract.putcontract
        with:
          orgId: rest.orgId
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecontract
        description: Delete Contract
        call: m3ter-contract.deletecontract
        with:
          orgId: rest.orgId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{orgid}/contracts/{id}/enddatebillingentities
      name: organizations-orgid-contracts-id-enddatebillingentities
      description: REST surface for organizations-orgId-contracts-id-enddatebillingentities.
      operations:
      - method: PUT
        name: enddatebillingentitiesforcontract
        description: End-date Contract Account billing entities
        call: m3ter-contract.enddatebillingentitiesforcontract
        with:
          orgId: rest.orgId
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: m3ter-contract-mcp
    port: 9090
    transport: http
    description: MCP adapter for m3ter API — Contract. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-contracts
      description: List Contracts
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-contract.listcontracts
      with:
        orgId: tools.orgId
        pageSize: tools.pageSize
        nextToken: tools.nextToken
        ids: tools.ids
        codes: tools.codes
        accountId: tools.accountId
      outputParameters:
      - type: object
        mapping: $.
    - name: create-contract
      description: Create Contract
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: m3ter-contract.postcontract
      with:
        orgId: tools.orgId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-contract
      description: Retrieve Contract
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-contract.getcontract
      with:
        orgId: tools.orgId
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-contract
      description: Update Contract
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: m3ter-contract.putcontract
      with:
        orgId: tools.orgId
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-contract
      description: Delete Contract
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: m3ter-contract.deletecontract
      with:
        orgId: tools.orgId
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: end-date-contract-account-billing
      description: End-date Contract Account billing entities
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: m3ter-contract.enddatebillingentitiesforcontract
      with:
        orgId: tools.orgId
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.