Unum HR Connect API — Billing

naftiko: 1.0.0-alpha2
info:
  label: Unum HR Connect API — Billing
  description: 'Unum HR Connect API — Billing. 2 operations. Lead operation: List Billing Invoices. Self-contained Naftiko
    capability covering one Unum business surface.'
  tags:
  - Unum
  - Billing
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UNUM_API_KEY: UNUM_API_KEY
capability:
  consumes:
  - type: http
    namespace: hr-connect-billing
    baseUri: https://api.unum.com/v1
    description: Unum HR Connect API — Billing business capability. Self-contained, no shared references.
    resources:
    - name: billing-invoices
      path: /billing/invoices
      operations:
      - name: listbillinginvoices
        method: GET
        description: List Billing Invoices
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupId
          in: query
          type: string
          description: Employer group identifier
          required: true
        - name: startDate
          in: query
          type: string
          description: Filter invoices from this date
        - name: endDate
          in: query
          type: string
          description: Filter invoices up to this date
        - name: page
          in: query
          type: integer
        - name: limit
          in: query
          type: integer
    - name: billing-invoices-invoiceId
      path: /billing/invoices/{invoiceId}
      operations:
      - name: getbillinginvoice
        method: GET
        description: Get Billing Invoice
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: invoiceId
          in: path
          type: string
          description: Invoice identifier
          required: true
    authentication:
      type: bearer
      token: '{{env.UNUM_API_KEY}}'
  exposes:
  - type: rest
    namespace: hr-connect-billing-rest
    port: 8080
    description: REST adapter for Unum HR Connect API — Billing. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/billing/invoices
      name: billing-invoices
      description: REST surface for billing-invoices.
      operations:
      - method: GET
        name: listbillinginvoices
        description: List Billing Invoices
        call: hr-connect-billing.listbillinginvoices
        with:
          groupId: rest.groupId
          startDate: rest.startDate
          endDate: rest.endDate
          page: rest.page
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/billing/invoices/{invoiceid}
      name: billing-invoices-invoiceid
      description: REST surface for billing-invoices-invoiceId.
      operations:
      - method: GET
        name: getbillinginvoice
        description: Get Billing Invoice
        call: hr-connect-billing.getbillinginvoice
        with:
          invoiceId: rest.invoiceId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: hr-connect-billing-mcp
    port: 9090
    transport: http
    description: MCP adapter for Unum HR Connect API — Billing. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-billing-invoices
      description: List Billing Invoices
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hr-connect-billing.listbillinginvoices
      with:
        groupId: tools.groupId
        startDate: tools.startDate
        endDate: tools.endDate
        page: tools.page
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: get-billing-invoice
      description: Get Billing Invoice
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hr-connect-billing.getbillinginvoice
      with:
        invoiceId: tools.invoiceId
      outputParameters:
      - type: object
        mapping: $.