NikoHealth integration

List Payments

Perform List Payments through NikoHealth.

nikohealth_list_payments

readnikohealth

Use in a workflow

Copy the discovered node config and fill its params from the input contract. Validate the complete graph before publishing. Integration results use {{node_id.default.field}}. Check business success before dependent writes; completion alone does not prove success.

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

Action contracts and connections · Run recovery

Inputs

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

Outputs

successSuccess
paymentsPayments
countCount
truncatedTruncated
errorError
error_typeError 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

{
  "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

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

View all NikoHealth actions