Etsy Open API v3 — Ledger Entry

naftiko: 1.0.0-alpha2
info:
  label: Etsy Open API v3 — Ledger Entry
  description: 'Etsy Open API v3 — Ledger Entry. 2 operations. Lead operation: Get Shop Payment Account Ledger Entry. Self-contained Naftiko capability covering one Etsy business surface.'
  tags:
    - Etsy
    - Open API v3
    - Ledger Entry
  created: '2026-05-30'
  modified: '2026-05-30'
binds:
  - namespace: env
    keys:
      ETSY_API_KEY: ETSY_API_KEY
      ETSY_OAUTH_TOKEN: ETSY_OAUTH_TOKEN
capability:
  consumes:
    - type: http
      namespace: open-api-v3-ledger-entry
      baseUri: https://openapi.etsy.com
      description: Etsy Open API v3 — Ledger Entry business capability. Self-contained, no shared references.
      authentication:
        type: apikey
        key: x-api-key
        value: '{{env.ETSY_API_KEY}}'
        placement: header
      resources:
        - name: shops-payment-account-ledger-entries
          path: /v3/application/shops/{shop_id}/payment-account/ledger-entries/{ledger_entry_id}
          operations:
            - name: getShopPaymentAccountLedgerEntry
              method: GET
              description: Get Shop Payment Account Ledger Entry
              inputParameters:
                - name: shop_id
                  in: path
                  type: integer
                  required: true
                  description: The unique positive non-zero numeric ID for an Etsy Shop.
                - name: ledger_entry_id
                  in: path
                  type: integer
                  required: true
                  description: The unique ID of the shop owner ledger entry.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
        - name: shops-payment-account-ledger-entries
          path: /v3/application/shops/{shop_id}/payment-account/ledger-entries
          operations:
            - name: getShopPaymentAccountLedgerEntries
              method: GET
              description: Get Shop Payment Account Ledger Entries
              inputParameters:
                - name: shop_id
                  in: path
                  type: integer
                  required: true
                  description: The unique positive non-zero numeric ID for an Etsy Shop.
                - name: min_created
                  in: query
                  type: integer
                  required: true
                  description: The earliest unix timestamp for when a record was created.
                - name: max_created
                  in: query
                  type: integer
                  required: true
                  description: The latest unix timestamp for when a record was created.
                - name: limit
                  in: query
                  type: integer
                  required: false
                  description: The maximum number of results to return.
                - name: offset
                  in: query
                  type: integer
                  required: false
                  description: The number of records to skip before selecting the first result.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
  exposes:
    - type: rest
      namespace: open-api-v3-ledger-entry-rest
      port: 8080
      description: REST adapter for Etsy Open API v3 — Ledger Entry. One Spectral-compliant resource per consumed operation, prefixed with /v1.
      resources:
        - path: /v1/shops/{shop_id}/payment-account/ledger-entries/{ledger_entry_id}
          name: shops-payment-account-ledger-entries
          description: REST surface for shops-payment-account-ledger-entries.
          operations:
            - method: GET
              name: getShopPaymentAccountLedgerEntry
              description: Get Shop Payment Account Ledger Entry
              call: open-api-v3-ledger-entry.getShopPaymentAccountLedgerEntry
              with:
                shop_id: rest.shop_id
                ledger_entry_id: rest.ledger_entry_id
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/shops/{shop_id}/payment-account/ledger-entries
          name: shops-payment-account-ledger-entries
          description: REST surface for shops-payment-account-ledger-entries.
          operations:
            - method: GET
              name: getShopPaymentAccountLedgerEntries
              description: Get Shop Payment Account Ledger Entries
              call: open-api-v3-ledger-entry.getShopPaymentAccountLedgerEntries
              with:
                shop_id: rest.shop_id
                min_created: rest.min_created
                max_created: rest.max_created
                limit: rest.limit
                offset: rest.offset
              outputParameters:
                - type: object
                  mapping: $.
    - type: mcp
      namespace: open-api-v3-ledger-entry-mcp
      port: 9090
      transport: http
      description: MCP adapter for Etsy Open API v3 — Ledger Entry. One tool per consumed operation, routed inline through this capability's consumes block.
      tools:
        - name: get-shop-payment-account-ledger-entry
          description: Get Shop Payment Account Ledger Entry
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: open-api-v3-ledger-entry.getShopPaymentAccountLedgerEntry
          with:
            shop_id: tools.shop_id
            ledger_entry_id: tools.ledger_entry_id
          outputParameters:
            - type: object
              mapping: $.
        - name: get-shop-payment-account-ledger-entries
          description: Get Shop Payment Account Ledger Entries
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: open-api-v3-ledger-entry.getShopPaymentAccountLedgerEntries
          with:
            shop_id: tools.shop_id
            min_created: tools.min_created
            max_created: tools.max_created
            limit: tools.limit
            offset: tools.offset
          outputParameters:
            - type: object
              mapping: $.