API Reference — E-Invoicing

naftiko: 1.0.0-alpha2
info:
  label: API Reference — E-Invoicing
  description: 'API Reference — E-Invoicing. 15 operations. Lead operation: Create an e-invoicing business region. Self-contained
    Naftiko capability covering one Zuora business surface.'
  tags:
  - Zuora
  - E-Invoicing
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZUORA_API_KEY: ZUORA_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-e-invoicing
    baseUri: https://rest.zuora.com
    description: API Reference — E-Invoicing business capability. Self-contained, no shared references.
    resources:
    - name: v1-einvoice-business-regions
      path: /v1/einvoice/business-regions
      operations:
      - name: postcreateeinvoicingbusinessregion
        method: POST
        description: Create an e-invoicing business region
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Request
          in: body
          type: string
          required: true
      - name: geteinvoicingbusinessregions
        method: GET
        description: List e-invoicing business regions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-einvoice-business-regions-key
      path: /v1/einvoice/business-regions/{key}
      operations:
      - name: geteinvoicingbusinessregion
        method: GET
        description: Retrieve an e-invoicing business region
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: key
          in: path
          type: string
          description: The unqiue ID or number of the e-invoicing business region that you want to retrieve information about.
          required: true
      - name: putupdateeinvoicingbusinessregion
        method: PUT
        description: Update an e-invoicing business region
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: key
          in: path
          type: string
          description: The unqiue ID or number of the e-invoicing business region that you want to update.
          required: true
        - name: Request
          in: body
          type: string
          required: true
      - name: deleteeinvoicingbusinessregion
        method: DELETE
        description: Delete an e-invoicing business region
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: key
          in: path
          type: string
          description: The unqiue ID or number of the e-invoicing business region that you want to delete.
          required: true
    - name: v1-einvoice-service-providers
      path: /v1/einvoice/service-providers
      operations:
      - name: posteinvoicingserviceprovider
        method: POST
        description: Create an e-invoicing service provider
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Request
          in: body
          type: string
          required: true
      - name: geteinvoicingserviceproviders
        method: GET
        description: List e-invoicing service providers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-einvoice-service-providers-key
      path: /v1/einvoice/service-providers/{key}
      operations:
      - name: geteinvoicingserviceprovider
        method: GET
        description: Retrieve an e-invoicing service provider
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: key
          in: path
          type: string
          description: The unique ID or number of the e-invoicing service provider that you want to retrieve information about.
          required: true
      - name: putupdateeinvoicingserviceprovider
        method: PUT
        description: Update an e-invoicing service provider
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: key
          in: path
          type: string
          description: The unique ID or number of the e-invoicing service provider that you want to update.
          required: true
        - name: Request
          in: body
          type: string
          required: true
      - name: deleteeinvoicingserviceprovider
        method: DELETE
        description: Delete an e-invoicing service provider
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: key
          in: path
          type: string
          description: The unique ID or number of the e-invoicing service provider that you want to
          required: true
    - name: v1-einvoice-templates
      path: /v1/einvoice/templates
      operations:
      - name: postcreateeinvoicefiletemplate
        method: POST
        description: Create an e-invoice file template
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Request
          in: body
          type: string
          required: true
      - name: geteinvoicefiletemplates
        method: GET
        description: List e-invoice file templates
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: country
          in: query
          type: string
          description: The short name of a country or region where you must comply with e-invoicing requirements. For example,
            `IN` for India. For the full list of country names and c
          required: true
        - name: documentType
          in: query
          type: string
          description: The type of billing documents for which the e-invoice file template is intended.
          required: true
        - name: provider
          in: query
          type: string
          description: The name of the e-invoicing service provider that assists in generating e-invoice files.
          required: true
    - name: v1-einvoice-templates-key
      path: /v1/einvoice/templates/{key}
      operations:
      - name: geteinvoicefiletemplate
        method: GET
        description: Retrieve an e-invoice file template
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: key
          in: path
          type: string
          description: The unique number or ID of the e-invoice file template that you want to retrieve information about.
          required: true
      - name: puteinvoicefiletemplate
        method: PUT
        description: Update an e-invoice file template
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: key
          in: path
          type: string
          description: The unique number or ID of the e-invoice file template that you want to update.
          required: true
        - name: Request
          in: body
          type: string
          required: true
      - name: deleteeinvoicefiletemplate
        method: DELETE
        description: Delete an e-invoice file template
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: key
          in: path
          type: string
          description: The unique ID or number of the e-invoice file template that you want to delete.
          required: true
  exposes:
  - type: rest
    namespace: v1-e-invoicing-rest
    port: 8080
    description: REST adapter for API Reference — E-Invoicing. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/einvoice/business-regions
      name: v1-einvoice-business-regions
      description: REST surface for v1-einvoice-business-regions.
      operations:
      - method: POST
        name: postcreateeinvoicingbusinessregion
        description: Create an e-invoicing business region
        call: v1-e-invoicing.postcreateeinvoicingbusinessregion
        with:
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: geteinvoicingbusinessregions
        description: List e-invoicing business regions
        call: v1-e-invoicing.geteinvoicingbusinessregions
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/einvoice/business-regions/{key}
      name: v1-einvoice-business-regions-key
      description: REST surface for v1-einvoice-business-regions-key.
      operations:
      - method: GET
        name: geteinvoicingbusinessregion
        description: Retrieve an e-invoicing business region
        call: v1-e-invoicing.geteinvoicingbusinessregion
        with:
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putupdateeinvoicingbusinessregion
        description: Update an e-invoicing business region
        call: v1-e-invoicing.putupdateeinvoicingbusinessregion
        with:
          key: rest.key
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteeinvoicingbusinessregion
        description: Delete an e-invoicing business region
        call: v1-e-invoicing.deleteeinvoicingbusinessregion
        with:
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/einvoice/service-providers
      name: v1-einvoice-service-providers
      description: REST surface for v1-einvoice-service-providers.
      operations:
      - method: POST
        name: posteinvoicingserviceprovider
        description: Create an e-invoicing service provider
        call: v1-e-invoicing.posteinvoicingserviceprovider
        with:
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: geteinvoicingserviceproviders
        description: List e-invoicing service providers
        call: v1-e-invoicing.geteinvoicingserviceproviders
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/einvoice/service-providers/{key}
      name: v1-einvoice-service-providers-key
      description: REST surface for v1-einvoice-service-providers-key.
      operations:
      - method: GET
        name: geteinvoicingserviceprovider
        description: Retrieve an e-invoicing service provider
        call: v1-e-invoicing.geteinvoicingserviceprovider
        with:
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putupdateeinvoicingserviceprovider
        description: Update an e-invoicing service provider
        call: v1-e-invoicing.putupdateeinvoicingserviceprovider
        with:
          key: rest.key
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteeinvoicingserviceprovider
        description: Delete an e-invoicing service provider
        call: v1-e-invoicing.deleteeinvoicingserviceprovider
        with:
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/einvoice/templates
      name: v1-einvoice-templates
      description: REST surface for v1-einvoice-templates.
      operations:
      - method: POST
        name: postcreateeinvoicefiletemplate
        description: Create an e-invoice file template
        call: v1-e-invoicing.postcreateeinvoicefiletemplate
        with:
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: geteinvoicefiletemplates
        description: List e-invoice file templates
        call: v1-e-invoicing.geteinvoicefiletemplates
        with:
          country: rest.country
          documentType: rest.documentType
          provider: rest.provider
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/einvoice/templates/{key}
      name: v1-einvoice-templates-key
      description: REST surface for v1-einvoice-templates-key.
      operations:
      - method: GET
        name: geteinvoicefiletemplate
        description: Retrieve an e-invoice file template
        call: v1-e-invoicing.geteinvoicefiletemplate
        with:
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: puteinvoicefiletemplate
        description: Update an e-invoice file template
        call: v1-e-invoicing.puteinvoicefiletemplate
        with:
          key: rest.key
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteeinvoicefiletemplate
        description: Delete an e-invoice file template
        call: v1-e-invoicing.deleteeinvoicefiletemplate
        with:
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-e-invoicing-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — E-Invoicing. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: create-e-invoicing-business-region
      description: Create an e-invoicing business region
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-e-invoicing.postcreateeinvoicingbusinessregion
      with:
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: list-e-invoicing-business-regions
      description: List e-invoicing business regions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-e-invoicing.geteinvoicingbusinessregions
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-e-invoicing-business-region
      description: Retrieve an e-invoicing business region
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-e-invoicing.geteinvoicingbusinessregion
      with:
        key: tools.key
      outputParameters:
      - type: object
        mapping: $.
    - name: update-e-invoicing-business-region
      description: Update an e-invoicing business region
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-e-invoicing.putupdateeinvoicingbusinessregion
      with:
        key: tools.key
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-e-invoicing-business-region
      description: Delete an e-invoicing business region
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v1-e-invoicing.deleteeinvoicingbusinessregion
      with:
        key: tools.key
      outputParameters:
      - type: object
        mapping: $.
    - name: create-e-invoicing-service-provider
      description: Create an e-invoicing service provider
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-e-invoicing.posteinvoicingserviceprovider
      with:
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: list-e-invoicing-service-providers
      description: List e-invoicing service providers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-e-invoicing.geteinvoicingserviceproviders
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-e-invoicing-service-provider
      description: Retrieve an e-invoicing service provider
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-e-invoicing.geteinvoicingserviceprovider
      with:
        key: tools.key
      outputParameters:
      - type: object
        mapping: $.
    - name: update-e-invoicing-service-provider
      description: Update an e-invoicing service provider
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-e-invoicing.putupdateeinvoicingserviceprovider
      with:
        key: tools.key
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-e-invoicing-service-provider
      description: Delete an e-invoicing service provider
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v1-e-invoicing.deleteeinvoicingserviceprovider
      with:
        key: tools.key
      outputParameters:
      - type: object
        mapping: $.
    - name: create-e-invoice-file-template
      description: Create an e-invoice file template
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-e-invoicing.postcreateeinvoicefiletemplate
      with:
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: list-e-invoice-file-templates
      description: List e-invoice file templates
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-e-invoicing.geteinvoicefiletemplates
      with:
        country: tools.country
        documentType: tools.documentType
        provider: tools.provider
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-e-invoice-file-template
      description: Retrieve an e-invoice file template
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-e-invoicing.geteinvoicefiletemplate
      with:
        key: tools.key
      outputParameters:
      - type: object
        mapping: $.
    - name: update-e-invoice-file-template
      description: Update an e-invoice file template
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-e-invoicing.puteinvoicefiletemplate
      with:
        key: tools.key
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-e-invoice-file-template
      description: Delete an e-invoice file template
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v1-e-invoicing.deleteeinvoicefiletemplate
      with:
        key: tools.key
      outputParameters:
      - type: object
        mapping: $.