# List Payments

> Perform List Payments through NikoHealth.

Source: [https://genhealth.ai/docs/workflows/integrations/nikohealth/nikohealth_list_payments](https://genhealth.ai/docs/workflows/integrations/nikohealth/nikohealth_list_payments)

Integration: [NikoHealth](https://genhealth.ai/docs/workflows/integrations/nikohealth.md)

- Handler: `nikohealth_list_payments`

- Connection type: `nikohealth`

## Use in a workflow

Copy this discovered node config, fill params from the input contract, and validate the complete graph. Integration results are available as {{node_id.default.field}}. Check business success before dependent writes; completion alone does not prove business success.

```json

{
  "_group": "NikoHealth",
  "params": {
    "status": [
      "New",
      "Unapplied"
    ],
    "max_results": 200,
    "source_type": "Insurance",
    "include_archived": false
  },
  "handler": "nikohealth_list_payments"
}

```

[Action contracts](https://genhealth.ai/docs/workflows/action-contracts.md) · [Run recovery](https://genhealth.ai/docs/workflows/operations.md)

## Inputs

- `status` — Status (multi_select)
  Optional list of selected values.
  Default: `["New","Unapplied"]`
  Options: New ("New"), Applied ("Applied"), Unapplied ("Unapplied"), Failed ("Failed"), Completed ("Completed")
- `source_type` — Source Type (select)
  Optional selected identifier or value.
  Default: `"Insurance"`
  Options: All (""), Patient ("Patient"), Insurance ("Insurance")
- `method` — Method (select)
  Optional selected identifier or value.
  Options: All (""), Other ("Other"), Cash ("Cash"), Check ("Check"), Eft ("Eft"), CreditCard ("CreditCard")
- `remittance_date_from` — Remittance Date From (date)
  Optional date in YYYY-MM-DD format.
- `remittance_date_to` — Remittance Date To (date)
  Optional date in YYYY-MM-DD format.
- `created_from` — Created From (text)
  Optional text value.
- `created_to` — Created To (text)
  Optional text value.
- `reference_number` — Reference Number (text)
  Optional text value.
- `payer_id` — Payer Id (text)
  Optional text value.
- `unapplied_min` — Unapplied Min (number)
  Optional numeric value.
- `unapplied_max` — Unapplied Max (number)
  Optional numeric value.
- `include_archived` — Include Archived (boolean)
  Optional true-or-false value.
  Default: `false`
- `max_results` — Max Results (number)
  Optional numeric value.
  Default: `200`

## Outputs

- `success` — Success
- `payments` — Payments
- `count` — Count
- `truncated` — Truncated
- `error` — Error
- `error_type` — Error Type

Output schema completeness: `best_effort_declared`

## Safety

- External effect: `read`
- Confirmation recommended: no
- Retry safe: yes
- Dry run supported: no

## Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

### Input schema

```json
{
  "type": "object",
  "properties": {
    "method": {
      "enum": [
        "",
        "Other",
        "Cash",
        "Check",
        "Eft",
        "CreditCard"
      ],
      "type": "string",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "status": {
      "type": "array",
      "items": {
        "enum": [
          "New",
          "Applied",
          "Unapplied",
          "Failed",
          "Completed"
        ],
        "type": "string"
      },
      "default": [
        "New",
        "Unapplied"
      ],
      "description": "Optional list of selected values.",
      "x-workflow-field-type": "multi_select"
    },
    "payer_id": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "created_to": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "max_results": {
      "type": "number",
      "default": 200,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "source_type": {
      "enum": [
        "",
        "Patient",
        "Insurance"
      ],
      "type": "string",
      "default": "Insurance",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "created_from": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "unapplied_max": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "unapplied_min": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "include_archived": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "reference_number": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "remittance_date_to": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "remittance_date_from": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    }
  },
  "additionalProperties": false
}
```

### Output schema

```json
{
  "type": "object",
  "properties": {
    "count": {},
    "error": {},
    "success": {},
    "payments": {},
    "truncated": {},
    "error_type": {}
  },
  "additionalProperties": true
}
```