naftiko: 1.0.0-alpha2
info:
  label: API Reference — Credit Memos
  description: 'API Reference — Credit Memos. 26 operations. Lead operation: Create a credit memo from a charge. Self-contained
    Naftiko capability covering one Zuora business surface.'
  tags:
  - Zuora
  - Credit Memos
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZUORA_API_KEY: ZUORA_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-credit-memos
    baseUri: https://rest.zuora.com
    description: API Reference — Credit Memos business capability. Self-contained, no shared references.
    resources:
    - name: v1-creditmemos
      path: /v1/creditmemos
      operations:
      - name: postcreditmemofromprpc
        method: POST
        description: Create a credit memo from a charge
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: zuora-version
          in: header
          type: string
          description: The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version)
            for information about REST API ve
        - name: body
          in: body
          type: string
          required: true
      - name: getcreditmemos
        method: GET
        description: List credit memos
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: query
          type: string
          description: This parameter filters the response based on the `accountId` field.
        - name: accountNumber
          in: query
          type: string
          description: This parameter filters the response based on the `accountNumber` field.
        - name: amount
          in: query
          type: number
          description: This parameter filters the response based on the `amount` field.
        - name: appliedAmount
          in: query
          type: number
          description: This parameter filters the response based on the `appliedAmount` field.
        - name: autoApplyUponPosting
          in: query
          type: boolean
          description: This parameter filters the response based on the `autoApplyUponPosting` field.
        - name: createdById
          in: query
          type: string
          description: This parameter filters the response based on the `createdById` field.
        - name: createdDate
          in: query
          type: string
          description: This parameter filters the response based on the `createdDate` field.
        - name: creditMemoDate
          in: query
          type: string
          description: This parameter filters the response based on the `creditMemoDate` field.
        - name: currency
          in: query
          type: string
          description: This parameter filters the response based on the `currency` field.
        - name: excludeFromAutoApplyRules
          in: query
          type: boolean
          description: This parameter filters the response based on the `excludeFromAutoApplyRules` field.
        - name: number
          in: query
          type: string
          description: This parameter filters the response based on the `number` field.
        - name: referredInvoiceId
          in: query
          type: string
          description: This parameter filters the response based on the `referredInvoiceId` field.
        - name: refundAmount
          in: query
          type: number
          description: This parameter filters the response based on the `refundAmount` field.
        - name: status
          in: query
          type: string
          description: This parameter filters the response based on the `status` field.
        - name: targetDate
          in: query
          type: string
          description: This parameter filters the response based on the `targetDate` field.
        - name: taxAmount
          in: query
          type: number
          description: This parameter filters the response based on the `taxAmount` field.
        - name: totalTaxExemptAmount
          in: query
          type: number
          description: This parameter filters the response based on the `totalTaxExemptAmount` field.
        - name: transferredToAccounting
          in: query
          type: string
          description: This parameter filters the response based on the `transferredToAccounting` field.
        - name: unappliedAmount
          in: query
          type: number
          description: This parameter filters the response based on the `unappliedAmount` field.
        - name: updatedById
          in: query
          type: string
          description: This parameter filters the response based on the `updatedById` field.
        - name: updatedDate
          in: query
          type: string
          description: This parameter filters the response based on the `updatedDate` field.
        - name: sort
          in: query
          type: string
          description: This parameter restricts the order of the data returned in the response. You can use this parameter
            to supply a dimension you want to sort on.
    - name: v1-creditmemos-bulk
      path: /v1/creditmemos/bulk
      operations:
      - name: postcreatecreditmemos
        method: POST
        description: Create credit memos
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: zuora-version
          in: header
          type: string
          description: The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version)
            for information about REST API ve
        - name: body
          in: body
          type: string
          required: true
      - name: putupdatecreditmemos
        method: PUT
        description: Update credit memos
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: zuora-version
          in: header
          type: string
          description: The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version)
            for information about REST API ve
        - name: body
          in: body
          type: string
          required: true
    - name: v1-creditmemos-creditMemoId-items-cmitemid-taxation-items
      path: /v1/creditmemos/{creditMemoId}/items/{cmitemid}/taxation-items
      operations:
      - name: gettaxationitemsofcreditmemoitem
        method: GET
        description: List all taxation items of a credit memo item
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cmitemid
          in: path
          type: string
          description: The unique ID of a credit memo item. You can get the credit memo item ID from the response of [List
            credit memo items](/api-references/api/operation/GET_CreditM
          required: true
        - name: creditMemoId
          in: path
          type: string
          description: The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.
          required: true
    - name: v1-creditmemos-creditMemoId-write-off
      path: /v1/creditmemos/{creditMemoId}/write-off
      operations:
      - name: putwriteoffcreditmemo
        method: PUT
        description: Write off a credit memo
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: creditMemoId
          in: path
          type: string
          description: The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.
          required: true
        - name: Request
          in: body
          type: string
          required: true
    - name: v1-creditmemos-creditMemoKey
      path: /v1/creditmemos/{creditMemoKey}
      operations:
      - name: getcreditmemo
        method: GET
        description: Retrieve a credit memo
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: creditMemoKey
          in: path
          type: string
          description: The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          required: true
      - name: putupdatecreditmemo
        method: PUT
        description: Update a credit memo
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: string
          required: true
        - name: creditMemoKey
          in: path
          type: string
          description: The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          required: true
      - name: deletecreditmemo
        method: DELETE
        description: Delete a credit memo
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: creditMemoKey
          in: path
          type: string
          description: The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          required: true
    - name: v1-creditmemos-creditMemoKey-apply
      path: /v1/creditmemos/{creditMemoKey}/apply
      operations:
      - name: putapplycreditmemo
        method: PUT
        description: Apply a credit memo
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: string
          required: true
        - name: creditMemoKey
          in: path
          type: string
          description: The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.
          required: true
    - name: v1-creditmemos-creditMemoKey-cancel
      path: /v1/creditmemos/{creditMemoKey}/cancel
      operations:
      - name: putcancelcreditmemo
        method: PUT
        description: Cancel a credit memo
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: creditMemoKey
          in: path
          type: string
          description: The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          required: true
    - name: v1-creditmemos-creditMemoKey-einvoice-generate
      path: /v1/creditmemos/{creditMemoKey}/einvoice/generate
      operations:
      - name: putgenerateeinvoicefileforcreditmemo
        method: PUT
        description: Generate an e-invoice file for a credit memo
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: creditMemoKey
          in: path
          type: string
          description: The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM-0000001.
          required: true
    - name: v1-creditmemos-creditMemoKey-emails
      path: /v1/creditmemos/{creditMemoKey}/emails
      operations:
      - name: postemailcreditmemo
        method: POST
        description: Email a credit memo
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Request
          in: body
          type: string
          required: true
        - name: creditMemoKey
          in: path
          type: string
          description: The ID or number of a posted credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          required: true
    - name: v1-creditmemos-creditMemoKey-files
      path: /v1/creditmemos/{creditMemoKey}/files
      operations:
      - name: postuploadfileforcreditmemo
        method: POST
        description: Upload a file for a credit memo
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: creditMemoKey
          in: path
          type: string
          description: The ID or number of the credit memo that you want to upload a PDF file for. For example, 402890555a7e9791015a879f064a0054
            or CM00000001.
          required: true
        - name: file
          in: formData
          type: file
          description: The PDF file to upload for the credit memo.
    - name: v1-creditmemos-creditMemoKey-items
      path: /v1/creditmemos/{creditMemoKey}/items
      operations:
      - name: getcreditmemoitems
        method: GET
        description: List credit memo items
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: creditMemoKey
          in: path
          type: string
          description: The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          required: true
        - name: zuora-version
          in: header
          type: string
          description: The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version)
            for information about REST API ve
        - name: amount
          in: query
          type: number
          description: This parameter filters the response based on the `amount` field.
        - name: appliedAmount
          in: query
          type: number
          description: This parameter filters the response based on the `appliedAmount` field.
        - name: createdById
          in: query
          type: string
          description: This parameter filters the response based on the `createdById` field.
        - name: createdDate
          in: query
          type: string
          description: This parameter filters the response based on the `createdDate` field.
        - name: id
          in: query
          type: string
          description: This parameter filters the response based on the `id` field.
        - name: refundAmount
          in: query
          type: number
          description: This parameter filters the response based on the `refundAmount` field.
        - name: serviceEndDate
          in: query
          type: string
          description: This parameter filters the response based on the `serviceEndDate` field.
        - name: serviceStartDate
          in: query
          type: string
          description: This parameter filters the response based on the `serviceStartDate` field.
        - name: sku
          in: query
          type: string
          description: This parameter filters the response based on the `sku` field.
        - name: skuName
          in: query
          type: string
          description: This parameter filters the response based on the `skuName` field.
        - name: sourceItemId
          in: query
          type: string
          description: This parameter filters the response based on the `sourceItemId` field.
        - name: subscriptionId
          in: query
          type: string
          description: This parameter filters the response based on the `subscriptionId` field.
        - name: updatedById
          in: query
          type: string
          description: This parameter filters the response based on the `updatedById` field.
        - name: updatedDate
          in: query
          type: string
          description: This parameter filters the response based on the `updatedDate` field.
        - name: sort
          in: query
          type: string
          description: This parameter restricts the order of the data returned in the response. You can use this parameter
            to supply a dimension you want to sort on.
    - name: v1-creditmemos-creditMemoKey-items-cmitemid
      path: /v1/creditmemos/{creditMemoKey}/items/{cmitemid}
      operations:
      - name: getcreditmemoitem
        method: GET
        description: Retrieve a credit memo item
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cmitemid
          in: path
          type: string
          description: The unique ID of a credit memo item. You can get the credit memo item ID from the response of [List
            credit memo items](/api-references/api/operation/GET_CreditM
          required: true
        - name: creditMemoKey
          in: path
          type: string
          description: The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          required: true
        - name: zuora-version
          in: header
          type: string
          description: The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version)
            for information about REST API ve
    - name: v1-creditmemos-creditMemoKey-parts
      path: /v1/creditmemos/{creditMemoKey}/parts
      operations:
      - name: getcreditmemoparts
        method: GET
        description: List all parts of a credit memo
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: creditMemoKey
          in: path
          type: string
          description: The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.
          required: true
    - name: v1-creditmemos-creditMemoKey-parts-partid
      path: /v1/creditmemos/{creditMemoKey}/parts/{partid}
      operations:
      - name: getcreditmemopart
        method: GET
        description: Retrieve a credit memo part
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: partid
          in: path
          type: string
          description: The unique ID of a specific credit memo part. You can get the credit memo part ID from the response
            of [List all parts of a credit memo](/api-references/api/ope
          required: true
        - name: creditMemoKey
          in: path
          type: string
          description: The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.
          required: true
    - name: v1-creditmemos-creditMemoKey-pdfs
      path: /v1/creditmemos/{creditMemoKey}/pdfs
      operations:
      - name: postcreditmemopdf
        method: POST
        description: Generate a credit memo PDF file
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: creditMemoKey
          in: path
          type: string
          description: The unique ID or number of the credit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba45ff82c7172
            or CM00000001.
          required: true
    - name: v1-creditmemos-creditMemoKey-post
      path: /v1/creditmemos/{creditMemoKey}/post
      operations:
      - name: putpostcreditmemo
        method: PUT
        description: Post a credit memo
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: creditMemoKey
          in: path
          type: string
          description: The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          required: true
    - name: v1-creditmemos-creditMemoKey-refunds
      path: /v1/creditmemos/{creditMemoKey}/refunds
      operations:
      - name: postrefundcreditmemo
        method: POST
        description: Refund a credit memo
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: string
          required: true
        - name: creditMemoKey
          in: path
          type: string
          description: The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001.
          required: true
    - name: v1-creditmemos-creditMemoKey-reverse
      path: /v1/creditmemos/{creditMemoKey}/reverse
      operations:
      - name: putreversecreditmemo
        method: PUT
        description: Reverse a credit memo
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: creditMemoKey
          in: path
          type: string
          description: The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001.
          required: true
        - name: Request
          in: body
          type: string
          required: true
    - name: v1-creditmemos-creditMemoKey-taxationitems
      path: /v1/creditmemos/{creditMemoKey}/taxationitems
      operations:
      - name: postcmtaxationitems
        method: POST
        description: Create taxation items for a credit memo
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: creditMemoKey
          in: path
          type: string
          description: The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          required: true
        - name: body
          in: body
          type: string
          required: true
    - name: v1-creditmemos-creditMemoKey-unapply
      path: /v1/creditmemos/{creditMemoKey}/unapply
      operations:
      - name: putunapplycreditmemo
        method: PUT
        description: Unapply a credit memo
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: string
          required: true
        - name: creditMemoKey
          in: path
          type: string
          description: The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.
          required: true
    - name: v1-creditmemos-creditMemoKey-unpost
      path: /v1/creditmemos/{creditMemoKey}/unpost
      operations:
      - name: putunpostcreditmemo
        method: PUT
        description: Unpost a credit memo
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: creditMemoKey
          in: path
          type: string
          description: The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          required: true
    - name: v1-invoices-invoiceKey-creditmemos
      path: /v1/invoices/{invoiceKey}/creditmemos
      operations:
      - name: postcreditmemofrominvoice
        method: POST
        description: Create a credit memo from an invoice
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: zuora-version
          in: header
          type: string
          description: The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version)
            for information about REST API ve
        - name: body
          in: body
          type: string
          required: true
        - name: invoiceKey
          in: path
          type: string
          description: The ID or number of an invoice that you want to create a credit memo from. For example, 2c93808457d787030157e030d10f3f64
            or INV00000001.
          required: true
  exposes:
  - type: rest
    namespace: v1-credit-memos-rest
    port: 8080
    description: REST adapter for API Reference — Credit Memos. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/creditmemos
      name: v1-creditmemos
      description: REST surface for v1-creditmemos.
      operations:
      - method: POST
        name: postcreditmemofromprpc
        description: Create a credit memo from a charge
        call: v1-credit-memos.postcreditmemofromprpc
        with:
          zuora-version: rest.zuora-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getcreditmemos
        description: List credit memos
        call: v1-credit-memos.getcreditmemos
        with:
          accountId: rest.accountId
          accountNumber: rest.accountNumber
          amount: rest.amount
          appliedAmount: rest.appliedAmount
          autoApplyUponPosting: rest.autoApplyUponPosting
          createdById: rest.createdById
          createdDate: rest.createdDate
          creditMemoDate: rest.creditMemoDate
          currency: rest.currency
          excludeFromAutoApplyRules: rest.excludeFromAutoApplyRules
          number: rest.number
          referredInvoiceId: rest.referredInvoiceId
          refundAmount: rest.refundAmount
          status: rest.status
          targetDate: rest.targetDate
          taxAmount: rest.taxAmount
          totalTaxExemptAmount: rest.totalTaxExemptAmount
          transferredToAccounting: rest.transferredToAccounting
          unappliedAmount: rest.unappliedAmount
          updatedById: rest.updatedById
          updatedDate: rest.updatedDate
          sort: rest.sort
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/creditmemos/bulk
      name: v1-creditmemos-bulk
      description: REST surface for v1-creditmemos-bulk.
      operations:
      - method: POST
        name: postcreatecreditmemos
        description: Create credit memos
        call: v1-credit-memos.postcreatecreditmemos
        with:
          zuora-version: rest.zuora-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putupdatecreditmemos
        description: Update credit memos
        call: v1-credit-memos.putupdatecreditmemos
        with:
          zuora-version: rest.zuora-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/creditmemos/{creditmemoid}/items/{cmitemid}/taxation-items
      name: v1-creditmemos-creditmemoid-items-cmitemid-taxation-items
      description: REST surface for v1-creditmemos-creditMemoId-items-cmitemid-taxation-items.
      operations:
      - method: GET
        name: gettaxationitemsofcreditmemoitem
        description: List all taxation items of a credit memo item
        call: v1-credit-memos.gettaxationitemsofcreditmemoitem
        with:
          cmitemid: rest.cmitemid
          creditMemoId: rest.creditMemoId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/creditmemos/{creditmemoid}/write-off
      name: v1-creditmemos-creditmemoid-write-off
      description: REST surface for v1-creditmemos-creditMemoId-write-off.
      operations:
      - method: PUT
        name: putwriteoffcreditmemo
        description: Write off a credit memo
        call: v1-credit-memos.putwriteoffcreditmemo
        with:
          creditMemoId: rest.creditMemoId
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/creditmemos/{creditmemokey}
      name: v1-creditmemos-creditmemokey
      description: REST surface for v1-creditmemos-creditMemoKey.
      operations:
      - method: GET
        name: getcreditmemo
        description: Retrieve a credit memo
        call: v1-credit-memos.getcreditmemo
        with:
          creditMemoKey: rest.creditMemoKey
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putupdatecreditmemo
        description: Update a credit memo
        call: v1-credit-memos.putupdatecreditmemo
        with:
          body: rest.body
          creditMemoKey: rest.creditMemoKey
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecreditmemo
        description: Delete a credit memo
        call: v1-credit-memos.deletecreditmemo
        with:
          creditMemoKey: rest.creditMemoKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/creditmemos/{creditmemokey}/apply
      name: v1-creditmemos-creditmemokey-apply
      description: REST surface for v1-creditmemos-creditMemoKey-apply.
      operations:
      - method: PUT
        name: putapplycreditmemo
        description: Apply a credit memo
        call: v1-credit-memos.putapplycreditmemo
        with:
          body: rest.body
          creditMemoKey: rest.creditMemoKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/creditmemos/{creditmemokey}/cancel
      name: v1-creditmemos-creditmemokey-cancel
      description: REST surface for v1-creditmemos-creditMemoKey-cancel.
      operations:
      - method: PUT
        name: putcancelcreditmemo
        description: Cancel a credit memo
        call: v1-credit-memos.putcancelcreditmemo
        with:
          creditMemoKey: rest.creditMemoKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/creditmemos/{creditmemokey}/einvoice/generate
      name: v1-creditmemos-creditmemokey-einvoice-generate
      description: REST surface for v1-creditmemos-creditMemoKey-einvoice-generate.
      operations:
      - method: PUT
        name: putgenerateeinvoicefileforcreditmemo
        description: Generate an e-invoice file for a credit memo
        call: v1-credit-memos.putgenerateeinvoicefileforcreditmemo
        with:
          creditMemoKey: rest.creditMemoKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/creditmemos/{creditmemokey}/emails
      name: v1-creditmemos-creditmemokey-emails
      description: REST surface for v1-creditmemos-creditMemoKey-emails.
      operations:
      - method: POST
        name: postemailcreditmemo
        description: Email a credit memo
        call: v1-credit-memos.postemailcreditmemo
        with:
          Request: rest.Request
          creditMemoKey: rest.creditMemoKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/creditmemos/{creditmemokey}/files
      name: v1-creditmemos-creditmemokey-files
      description: REST surface for v1-creditmemos-creditMemoKey-files.
      operations:
      - method: POST
        name: postuploadfileforcreditmemo
        description: Upload a file for a credit memo
        call: v1-credit-memos.postuploadfileforcreditmemo
        with:
          creditMemoKey: rest.creditMemoKey
          file: rest.file
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/creditmemos/{creditmemokey}/items
      name: v1-creditmemos-creditmemokey-items
      description: REST surface for v1-creditmemos-creditMemoKey-items.
      operations:
      - method: GET
        name: getcreditmemoitems
        description: List credit memo items
        call: v1-credit-memos.getcreditmemoitems
        with:
          creditMemoKey: rest.creditMemoKey
          zuora-version: rest.zuora-version
          amount: rest.amount
          appliedAmount: rest.appliedAmount
          createdById: rest.createdById
          createdDate: rest.createdDate
          id: rest.id
          refundAmount: rest.refundAmount
          serviceEndDate: rest.serviceEndDate
          serviceStartDate: rest.serviceStartDate
          sku: rest.sku
          skuName: rest.skuName
          sourceItemId: rest.sourceItemId
          subscriptionId: rest.subscriptionId
          updatedById: rest.updatedById
          updatedDate: rest.updatedDate
          sort: rest.sort
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/creditmemos/{creditmemokey}/items/{cmitemid}
      name: v1-creditmemos-creditmemokey-items-cmitemid
      description: REST surface for v1-creditmemos-creditMemoKey-items-cmitemid.
      operations:
      - method: GET
        name: getcreditmemoitem
        description: Retrieve a credit memo item
        call: v1-credit-memos.getcreditmemoitem
        with:
          cmitemid: rest.cmitemid
          creditMemoKey: rest.creditMemoKey
          zuora-version: rest.zuora-version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/creditmemos/{creditmemokey}/parts
      name: v1-creditmemos-creditmemokey-parts
      description: REST surface for v1-creditmemos-creditMemoKey-parts.
      operations:
      - method: GET
        name: getcreditmemoparts
        description: List all parts of a credit memo
        call: v1-credit-memos.getcreditmemoparts
        with:
          creditMemoKey: rest.creditMemoKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/creditmemos/{creditmemokey}/parts/{partid}
      name: v1-creditmemos-creditmemokey-parts-partid
      description: REST surface for v1-creditmemos-creditMemoKey-parts-partid.
      operations:
      - method: GET
        name: getcreditmemopart
        description: Retrieve a credit memo part
        call: v1-credit-memos.getcreditmemopart
        with:
          partid: rest.partid
          creditMemoKey: rest.creditMemoKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/creditmemos/{creditmemokey}/pdfs
      name: v1-creditmemos-creditmemokey-pdfs
      description: REST surface for v1-creditmemos-creditMemoKey-pdfs.
      operations:
      - method: POST
        name: postcreditmemopdf
        description: Generate a credit memo PDF file
        call: v1-credit-memos.postcreditmemopdf
        with:
          creditMemoKey: rest.creditMemoKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/creditmemos/{creditmemokey}/post
      name: v1-creditmemos-creditmemokey-post
      description: REST surface for v1-creditmemos-creditMemoKey-post.
      operations:
      - method: PUT
        name: putpostcreditmemo
        description: Post a credit memo
        call: v1-credit-memos.putpostcreditmemo
        with:
          creditMemoKey: rest.creditMemoKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/creditmemos/{creditmemokey}/refunds
      name: v1-creditmemos-creditmemokey-refunds
      description: REST surface for v1-creditmemos-creditMemoKey-refunds.
      operations:
      - method: POST
        name: postrefundcreditmemo
        description: Refund a credit memo
        call: v1-credit-memos.postrefundcreditmemo
        with:
          body: rest.body
          creditMemoKey: rest.creditMemoKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/creditmemos/{creditmemokey}/reverse
      name: v1-creditmemos-creditmemokey-reverse
      description: REST surface for v1-creditmemos-creditMemoKey-reverse.
      operations:
      - method: PUT
        name: putreversecreditmemo
        description: Reverse a credit memo
        call: v1-credit-memos.putreversecreditmemo
        with:
          creditMemoKey: rest.creditMemoKey
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/creditmemos/{creditmemokey}/taxationitems
      name: v1-creditmemos-creditmemokey-taxationitems
      description: REST surface for v1-creditmemos-creditMemoKey-taxationitems.
      operations:
      - method: POST
        name: postcmtaxationitems
        description: Create taxation items for a credit memo
        call: v1-credit-memos.postcmtaxationitems
        with:
          creditMemoKey: rest.creditMemoKey
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/creditmemos/{creditmemokey}/unapply
      name: v1-creditmemos-creditmemokey-unapply
      description: REST surface for v1-creditmemos-creditMemoKey-unapply.
      operations:
      - method: PUT
        name: putunapplycreditmemo
        description: Unapply a credit memo
        call: v1-credit-memos.putunapplycreditmemo
        with:
          body: rest.body
          creditMemoKey: rest.creditMemoKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/creditmemos/{creditmemokey}/unpost
      name: v1-creditmemos-creditmemokey-unpost
      description: REST surface for v1-creditmemos-creditMemoKey-unpost.
      operations:
      - method: PUT
        name: putunpostcreditmemo
        description: Unpost a credit memo
        call: v1-credit-memos.putunpostcreditmemo
        with:
          creditMemoKey: rest.creditMemoKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/invoices/{invoicekey}/creditmemos
      name: v1-invoices-invoicekey-creditmemos
      description: REST surface for v1-invoices-invoiceKey-creditmemos.
      operations:
      - method: POST
        name: postcreditmemofrominvoice
        description: Create a credit memo from an invoice
        call: v1-credit-memos.postcreditmemofrominvoice
        with:
          zuora-version: rest.zuora-version
          body: rest.body
          invoiceKey: rest.invoiceKey
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-credit-memos-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — Credit Memos. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: create-credit-memo-charge
      description: Create a credit memo from a charge
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-credit-memos.postcreditmemofromprpc
      with:
        zuora-version: tools.zuora-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-credit-memos
      description: List credit memos
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-credit-memos.getcreditmemos
      with:
        accountId: tools.accountId
        accountNumber: tools.accountNumber
        amount: tools.amount
        appliedAmount: tools.appliedAmount
        autoApplyUponPosting: tools.autoApplyUponPosting
        createdById: tools.createdById
        createdDate: tools.createdDate
        creditMemoDate: tools.creditMemoDate
        currency: tools.currency
        excludeFromAutoApplyRules: tools.excludeFromAutoApplyRules
        number: tools.number
        referredInvoiceId: tools.referredInvoiceId
        refundAmount: tools.refundAmount
        status: tools.status
        targetDate: tools.targetDate
        taxAmount: tools.taxAmount
        totalTaxExemptAmount: tools.totalTaxExemptAmount
        transferredToAccounting: tools.transferredToAccounting
        unappliedAmount: tools.unappliedAmount
        updatedById: tools.updatedById
        updatedDate: tools.updatedDate
        sort: tools.sort
      outputParameters:
      - type: object
        mapping: $.
    - name: create-credit-memos
      description: Create credit memos
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-credit-memos.postcreatecreditmemos
      with:
        zuora-version: tools.zuora-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-credit-memos
      description: Update credit memos
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-credit-memos.putupdatecreditmemos
      with:
        zuora-version: tools.zuora-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-taxation-items-credit
      description: List all taxation items of a credit memo item
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-credit-memos.gettaxationitemsofcreditmemoitem
      with:
        cmitemid: tools.cmitemid
        creditMemoId: tools.creditMemoId
      outputParameters:
      - type: object
        mapping: $.
    - name: write-off-credit-memo
      description: Write off a credit memo
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-credit-memos.putwriteoffcreditmemo
      with:
        creditMemoId: tools.creditMemoId
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-credit-memo
      description: Retrieve a credit memo
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-credit-memos.getcreditmemo
      with:
        creditMemoKey: tools.creditMemoKey
      outputParameters:
      - type: object
        mapping: $.
    - name: update-credit-memo
      description: Update a credit memo
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-credit-memos.putupdatecreditmemo
      with:
        body: tools.body
        creditMemoKey: tools.creditMemoKey
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-credit-memo
      description: Delete a credit memo
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v1-credit-memos.deletecreditmemo
      with:
        creditMemoKey: tools.creditMemoKey
      outputParameters:
      - type: object
        mapping: $.
    - name: apply-credit-memo
      description: Apply a credit memo
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-credit-memos.putapplycreditmemo
      with:
        body: tools.body
        creditMemoKey: tools.creditMemoKey
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-credit-memo
      description: Cancel a credit memo
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-credit-memos.putcancelcreditmemo
      with:
        creditMemoKey: tools.creditMemoKey
      outputParameters:
      - type: object
        mapping: $.
    - name: generate-e-invoice-file-credit
      description: Generate an e-invoice file for a credit memo
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-credit-memos.putgenerateeinvoicefileforcreditmemo
      with:
        creditMemoKey: tools.creditMemoKey
      outputParameters:
      - type: object
        mapping: $.
    - name: email-credit-memo
      description: Email a credit memo
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-credit-memos.postemailcreditmemo
      with:
        Request: tools.Request
        creditMemoKey: tools.creditMemoKey
      outputParameters:
      - type: object
        mapping: $.
    - name: upload-file-credit-memo
      description: Upload a file for a credit memo
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-credit-memos.postuploadfileforcreditmemo
      with:
        creditMemoKey: tools.creditMemoKey
        file: tools.file
      outputParameters:
      - type: object
        mapping: $.
    - name: list-credit-memo-items
      description: List credit memo items
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-credit-memos.getcreditmemoitems
      with:
        creditMemoKey: tools.creditMemoKey
        zuora-version: tools.zuora-version
        amount: tools.amount
        appliedAmount: tools.appliedAmount
        createdById: tools.createdById
        createdDate: tools.createdDate
        id: tools.id
        refundAmount: tools.refundAmount
        serviceEndDate: tools.serviceEndDate
        serviceStartDate: tools.serviceStartDate
        sku: tools.sku
        skuName: tools.skuName
        sourceItemId: tools.sourceItemId
        subscriptionId: tools.subscriptionId
        updatedById: tools.updatedById
        updatedDate: tools.updatedDate
        sort: tools.sort
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-credit-memo-item
      description: Retrieve a credit memo item
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-credit-memos.getcreditmemoitem
      with:
        cmitemid: tools.cmitemid
        creditMemoKey: tools.creditMemoKey
        zuora-version: tools.zuora-version
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-parts-credit-memo
      description: List all parts of a credit memo
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-credit-memos.getcreditmemoparts
      with:
        creditMemoKey: tools.creditMemoKey
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-credit-memo-part
      description: Retrieve a credit memo part
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-credit-memos.getcreditmemopart
      with:
        partid: tools.partid
        creditMemoKey: tools.creditMemoKey
      outputParameters:
      - type: object
        mapping: $.
    - name: generate-credit-memo-pdf-file
      description: Generate a credit memo PDF file
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-credit-memos.postcreditmemopdf
      with:
        creditMemoKey: tools.creditMemoKey
      outputParameters:
      - type: object
        mapping: $.
    - name: post-credit-memo
      description: Post a credit memo
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-credit-memos.putpostcreditmemo
      with:
        creditMemoKey: tools.creditMemoKey
      outputParameters:
      - type: object
        mapping: $.
    - name: refund-credit-memo
      description: Refund a credit memo
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-credit-memos.postrefundcreditmemo
      with:
        body: tools.body
        creditMemoKey: tools.creditMemoKey
      outputParameters:
      - type: object
        mapping: $.
    - name: reverse-credit-memo
      description: Reverse a credit memo
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-credit-memos.putreversecreditmemo
      with:
        creditMemoKey: tools.creditMemoKey
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: create-taxation-items-credit-memo
      description: Create taxation items for a credit memo
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-credit-memos.postcmtaxationitems
      with:
        creditMemoKey: tools.creditMemoKey
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: unapply-credit-memo
      description: Unapply a credit memo
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-credit-memos.putunapplycreditmemo
      with:
        body: tools.body
        creditMemoKey: tools.creditMemoKey
      outputParameters:
      - type: object
        mapping: $.
    - name: unpost-credit-memo
      description: Unpost a credit memo
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-credit-memos.putunpostcreditmemo
      with:
        creditMemoKey: tools.creditMemoKey
      outputParameters:
      - type: object
        mapping: $.
    - name: create-credit-memo-invoice
      description: Create a credit memo from an invoice
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-credit-memos.postcreditmemofrominvoice
      with:
        zuora-version: tools.zuora-version
        body: tools.body
        invoiceKey: tools.invoiceKey
      outputParameters:
      - type: object
        mapping: $.