{
  "opencollection": "1.0.0",
  "info": {
    "name": "NexHealth Adjustment Types Payments API",
    "version": "v20240412"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Payments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View payments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://nexhealth.info/payments",
            "headers": [
              {
                "name": "Nex-Api-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "subdomain",
                "value": "",
                "type": "query",
                "description": "Used to scope the request to the specified institution"
              },
              {
                "name": "location_id",
                "value": "",
                "type": "query",
                "description": "Used to scope the request to the specified location"
              },
              {
                "name": "patient_id",
                "value": "3",
                "type": "query",
                "description": "Filter by the id of the associated patient"
              },
              {
                "name": "provider_id",
                "value": "15",
                "type": "query",
                "description": "Filter by the id of the associated provider"
              },
              {
                "name": "guarantor_id",
                "value": "5",
                "type": "query",
                "description": "Filter by the id of the associated guarantor"
              },
              {
                "name": "charge_id",
                "value": "1111",
                "type": "query",
                "description": "Filter by the id of the associated charge"
              },
              {
                "name": "claim_id",
                "value": "2222",
                "type": "query",
                "description": "Filter by the id of the associated claim"
              },
              {
                "name": "transaction_id",
                "value": "NHP:JXZEQ1234",
                "type": "query",
                "description": "Filter by transaction id"
              },
              {
                "name": "updated_since",
                "value": "2024-04-12T10:30:00Z",
                "type": "query",
                "description": "Filter for payments updated since a specific time (UTC)"
              },
              {
                "name": "include_deleted",
                "value": "false",
                "type": "query",
                "description": "Include deleted payments"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n  * updated_at\n  * -updated_at\n"
              },
              {
                "name": "start_cursor",
                "value": "",
                "type": "query",
                "description": "First item of the current page. Starts empty"
              },
              {
                "name": "end_cursor",
                "value": "",
                "type": "query",
                "description": "Last item of the current page. Starts empty"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page. Maximum allowed amount is 1000."
              }
            ]
          },
          "docs": "This endpoint returns the ledger payments for the specified location, narrowed down by the configured filters (at least one filter is required)"
        },
        {
          "info": {
            "name": "Create payment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://nexhealth.info/payments",
            "headers": [
              {
                "name": "Nex-Api-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "subdomain",
                "value": "",
                "type": "query",
                "description": "Used to scope the request to the specified institution"
              },
              {
                "name": "location_id",
                "value": "",
                "type": "query",
                "description": "Used to scope the request to the specified location"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint enqueues a write-back that records the payment in the integrated health record system"
        },
        {
          "info": {
            "name": "View payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://nexhealth.info/payments/:id",
            "headers": [
              {
                "name": "Nex-Api-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "subdomain",
                "value": "",
                "type": "query",
                "description": "Used to scope the request to the specified institution"
              },
              {
                "name": "include[]",
                "value": "",
                "type": "query",
                "description": "Resources to be included in the response"
              }
            ]
          },
          "docs": "This endpoint returns a single ledger payment"
        }
      ]
    }
  ],
  "bundled": true
}