naftiko: 1.0.0-alpha2
info:
  label: Housecall Pro Public API — Invoices
  description: Housecall Pro Public API — Invoices. CRUD operations against the /invoices resource including
    sent, paid, voided, and refunded status transitions, plus nested payments.
  tags:
  - Housecall Pro
  - Invoices
  - Payments
  - Billing
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
- namespace: env
  keys:
    HOUSECALL_PRO_API_KEY: HOUSECALL_PRO_API_KEY
capability:
  consumes:
  - type: http
    namespace: invoices
    baseUri: https://api.housecallpro.com
    description: Housecall Pro Invoices business capability.
    resources:
    - name: invoices
      path: /invoices
      operations:
      - name: listinvoices
        method: GET
        description: List Housecall Pro Invoices
      - name: createinvoice
        method: POST
        description: Create A Housecall Pro Invoice
    - name: invoice
      path: /invoices/{invoice_id}
      operations:
      - name: getinvoice
        method: GET
        description: Get A Housecall Pro Invoice
        inputParameters:
        - name: invoice_id
          in: path
          type: string
          required: true
    - name: invoice-payments
      path: /invoices/{invoice_id}/payments
      operations:
      - name: listinvoicepayments
        method: GET
        description: List Housecall Pro Invoice Payments
        inputParameters:
        - name: invoice_id
          in: path
          type: string
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: 'Token {{env.HOUSECALL_PRO_API_KEY}}'
      placement: header