{
  "opencollection": "1.0.0",
  "info": {
    "name": "NexHealth Adjustment Types Balances API",
    "version": "v20240412"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Balances",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View guarantor balances",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://nexhealth.info/guarantor_balances",
            "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": "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": "guarantor_id",
                "value": "115",
                "type": "query",
                "description": "Filter by the id of the associated guarantor"
              },
              {
                "name": "updated_since",
                "value": "2024-04-12T10:30:00Z",
                "type": "query",
                "description": "Guarantor balances updated after the specified time (UTC)"
              },
              {
                "name": "show_zero_balances",
                "value": "false",
                "type": "query",
                "description": "Show guarantor balances with zero total balance"
              },
              {
                "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 guarantor balances for the specified location. At least one of the guarantor_id or updated_since filters must be provided"
        },
        {
          "info": {
            "name": "View guarantor balance",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://nexhealth.info/guarantor_balances/:id",
            "headers": [
              {
                "name": "Nex-Api-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "include[]",
                "value": "",
                "type": "query",
                "description": "Resources to be included in the response"
              }
            ]
          },
          "docs": "This endpoint returns a single guarantor balance"
        },
        {
          "info": {
            "name": "View insurance balances",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://nexhealth.info/insurance_balances",
            "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": "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": "patient_id",
                "value": "162",
                "type": "query",
                "description": "Filter for balances of a specific patient"
              },
              {
                "name": "guarantor_id",
                "value": "1001",
                "type": "query",
                "description": "Filter for balances of a specific guarantor"
              },
              {
                "name": "updated_since",
                "value": "2024-04-12T10:30:00Z",
                "type": "query",
                "description": "Insurance balances updated at or after the specified time (UTC). The comparison is inclusive, so a record whose updated_at exactly equals the given value is returned"
              },
              {
                "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 a list of insurance balances for a location: the amounts insurance is expected to pay, broken into aging buckets. You can filter by patient_id, guarantor_id or updated_since, and must provide at least one of these filters. location_id is always required, but does not satisfy the at-least-one-filter requirement on its own."
        },
        {
          "info": {
            "name": "View insurance balance",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://nexhealth.info/insurance_balances/:id",
            "headers": [
              {
                "name": "Nex-Api-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the insurance balance"
              },
              {
                "name": "subdomain",
                "value": "",
                "type": "query",
                "description": "Used to scope the request to the specified institution"
              }
            ]
          },
          "docs": "This endpoint returns a single insurance balance by its NexHealth id. Responds with a 404 when no insurance balance with this id exists or when it belongs to a location your token cannot access."
        }
      ]
    }
  ],
  "bundled": true
}