# getRecipientPayments

**Identifier:** `openpayments_getRecipientPayments`

**Provider:** [OpenPayments](https://kirha.com/providers/openpayments.md)

Get everything industry paid one US clinician (by NPI) in CMS Open Payments: yearly totals since 2019 (general, research, ownership), totals per paying company across all years, and for one program year the breakdown by company, nature of payment and product. Use for KOL profiling and conflict-of-interest checks.

## Run it with the CLI

```bash
kirha tools run openpayments_getRecipientPayments \
  --input '{
    "npi": "<npi>"
  }'
```

`--input` takes a JSON object that matches the input schema. Pass `--input -` to read it from stdin.

## Call it over HTTP

```bash
curl https://api.kirha.com/tools/v1/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: **********' \
  --data '{
  "tool_name": "openpayments_getRecipientPayments",
  "input": {
    "npi": "<npi>"
  }
}'
```

Replace the stars with an API key from https://app.kirha.com/api-keys.

## Input schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "npi": {
      "description": "10-digit NPI",
      "pattern": "^\\d{10}$",
      "type": "string"
    },
    "programYear": {
      "description": "Program year. Defaults to the latest published year (CMS publishes each June).",
      "maximum": 2100,
      "minimum": 2013,
      "type": "integer"
    }
  },
  "required": [
    "npi"
  ],
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "allYearsByCompany": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "amount": {
            "type": "number"
          },
          "companyId": {
            "type": "string"
          },
          "companyName": {
            "type": "string"
          },
          "paymentType": {
            "type": "string"
          },
          "transactions": {
            "type": "number"
          }
        },
        "required": [
          "companyId",
          "companyName",
          "amount",
          "transactions"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "breakdownYear": {
      "type": "number"
    },
    "city": {
      "type": "string"
    },
    "companyIds": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "context": {
      "type": "string"
    },
    "currency": {
      "const": "usd",
      "type": "string"
    },
    "fullName": {
      "type": "string"
    },
    "generalPaymentsBreakdown": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "amount": {
            "type": "number"
          },
          "companyId": {
            "type": "string"
          },
          "companyName": {
            "type": "string"
          },
          "natureOfPayment": {
            "type": "string"
          },
          "productName": {
            "type": "string"
          },
          "transactions": {
            "type": "number"
          }
        },
        "required": [
          "companyId",
          "companyName",
          "natureOfPayment",
          "amount",
          "transactions"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "npi": {
      "type": "string"
    },
    "profileIds": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "specialty": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "yearlyTotals": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "associatedResearchFunding": {
            "description": "Research payments to institutions where this clinician is principal investigator",
            "type": "number"
          },
          "generalPayments": {
            "type": "number"
          },
          "generalTransactions": {
            "type": "number"
          },
          "ownershipInvestment": {
            "type": "number"
          },
          "ownershipValue": {
            "type": "number"
          },
          "programYear": {
            "type": "number"
          },
          "researchPayments": {
            "type": "number"
          }
        },
        "required": [
          "programYear",
          "generalPayments",
          "researchPayments",
          "associatedResearchFunding",
          "ownershipInvestment",
          "ownershipValue",
          "generalTransactions"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "context",
    "npi",
    "currency",
    "yearlyTotals",
    "allYearsByCompany",
    "breakdownYear",
    "generalPaymentsBreakdown",
    "companyIds"
  ],
  "type": "object"
}
```

## Related tools

Other OpenPayments tools that this tool refers to, or that refer to it.

- [`searchOpenPaymentsRecipients`](https://kirha.com/providers/openpayments/searchOpenPaymentsRecipients.md)

-----

[All OpenPayments tools](https://kirha.com/providers/openpayments.md) · [< Back to tools list](https://kirha.com/tools.md)