{ "info": { "_postman_id": "7fd23054-1bd1-454e-86f8-f22c04a44ab1", "name": "NexHealth Adjustment Types Payment Plans API", "description": "v3.0.0 and v20240412 are two names for the same API version; the Nex-Api-Version header accepts either value. Welcome to the developer hub and documentation for NexHealth API. This section of guide describes the operations, response parameters, request parameters, and parameter constraints related to User API. The term Operations refer to functions or methods. The operations are included in requests and send to the web server. Each operation performs a different action or a query on database.\n\nContact Support:\n Name: NexHealth\n Email: info@nexhealth.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:20:11.000Z", "updatedAt": "2026-07-28T02:20:15.000Z", "lastUpdatedBy": "35240", "uid": "35240-7fd23054-1bd1-454e-86f8-f22c04a44ab1" }, "item": [ { "name": "payment_plans", "item": [ { "name": "{id}", "item": [ { "name": "View payment plan", "id": "18621049-1118-41be-91c4-42f63c82a596", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.Nexhealth+json;version=2" } ], "url": { "raw": "{{baseUrl}}/payment_plans/:id?include[]=patient&include[]=patient", "host": [ "{{baseUrl}}" ], "path": [ "payment_plans", ":id" ], "query": [ { "description": "Resources to be included in the response", "key": "include[]", "value": "patient" }, { "description": "Resources to be included in the response", "key": "include[]", "value": "patient" } ], "variable": [ { "id": "45fc04bf-a1e7-458f-b3be-755a27c6ca37", "key": "id", "value": "", "description": "(Required) " } ] } }, "response": [ { "id": "0fdd48a3-11cb-43ba-8994-444f8308aeb2", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.Nexhealth+json;version=2" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_plans/:id?include[]=patient", "host": [ "{{baseUrl}}" ], "path": [ "payment_plans", ":id" ], "query": [ { "description": "Resources to be included in the response", "key": "include[]", "value": "patient" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.Nexhealth+json;version=2" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"error\": [\n \"\",\n \"\"\n ],\n \"data\": {\n \"id\": \"\",\n \"patient_id\": \"\",\n \"guarantor_id\": \"\",\n \"first_payment_due_date\": \"\",\n \"created_date\": \"\",\n \"active\": \"\",\n \"patient\": {\n \"id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"last_name\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"institution_id\": \"\",\n \"foreign_id\": \"\",\n \"foreign_id_type\": \"\",\n \"bio\": {},\n \"inactive\": \"\",\n \"last_sync_time\": \"\",\n \"guarantor_id\": \"\",\n \"billing_type\": \"\",\n \"chart_id\": \"\",\n \"preferred_language\": \"\",\n \"preferred_locale\": \"\",\n \"location_ids\": [\n \"\",\n \"\"\n ]\n },\n \"guarantor\": {\n \"id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"last_name\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"institution_id\": \"\",\n \"foreign_id\": \"\",\n \"foreign_id_type\": \"\",\n \"bio\": {},\n \"inactive\": \"\",\n \"last_sync_time\": \"\",\n \"guarantor_id\": \"\",\n \"billing_type\": \"\",\n \"chart_id\": \"\",\n \"preferred_language\": \"\",\n \"preferred_locale\": \"\",\n \"location_ids\": [\n \"\",\n \"\"\n ]\n }\n },\n \"count\": \"\"\n}", "createdAt": "2026-07-28T02:20:15.000Z", "updatedAt": "2026-07-28T02:20:15.000Z", "uid": "35240-0fdd48a3-11cb-43ba-8994-444f8308aeb2" }, { "id": "c67a0933-b06e-42b7-8404-9c3277ca3307", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.Nexhealth+json;version=2" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_plans/:id?include[]=patient", "host": [ "{{baseUrl}}" ], "path": [ "payment_plans", ":id" ], "query": [ { "description": "Resources to be included in the response", "key": "include[]", "value": "patient" } ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.Nexhealth+json;version=2" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:15.000Z", "updatedAt": "2026-07-28T02:20:15.000Z", "uid": "35240-c67a0933-b06e-42b7-8404-9c3277ca3307" }, { "id": "09ae3bfa-5181-4c13-a67e-4866122863b1", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.Nexhealth+json;version=2" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_plans/:id?include[]=patient", "host": [ "{{baseUrl}}" ], "path": [ "payment_plans", ":id" ], "query": [ { "description": "Resources to be included in the response", "key": "include[]", "value": "patient" } ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.Nexhealth+json;version=2" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:15.000Z", "updatedAt": "2026-07-28T02:20:15.000Z", "uid": "35240-09ae3bfa-5181-4c13-a67e-4866122863b1" }, { "id": "35c26b93-1ff2-4644-81e8-9f3b360e3d55", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.Nexhealth+json;version=2" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_plans/:id?include[]=patient", "host": [ "{{baseUrl}}" ], "path": [ "payment_plans", ":id" ], "query": [ { "description": "Resources to be included in the response", "key": "include[]", "value": "patient" } ], "variable": [ { "key": "id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.Nexhealth+json;version=2" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:15.000Z", "updatedAt": "2026-07-28T02:20:15.000Z", "uid": "35240-35c26b93-1ff2-4644-81e8-9f3b360e3d55" }, { "id": "e7b9dea4-de5e-45f3-beaf-05b50d6115de", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.Nexhealth+json;version=2" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_plans/:id?include[]=patient", "host": [ "{{baseUrl}}" ], "path": [ "payment_plans", ":id" ], "query": [ { "description": "Resources to be included in the response", "key": "include[]", "value": "patient" } ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.Nexhealth+json;version=2" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:15.000Z", "updatedAt": "2026-07-28T02:20:15.000Z", "uid": "35240-e7b9dea4-de5e-45f3-beaf-05b50d6115de" } ], "createdAt": "2026-07-28T02:20:15.000Z", "updatedAt": "2026-07-28T02:20:15.000Z", "uid": "35240-18621049-1118-41be-91c4-42f63c82a596" } ], "id": "90079c23-57d4-4205-a08d-5387233071be", "createdAt": "2026-07-28T02:20:12.000Z", "updatedAt": "2026-07-28T02:20:12.000Z", "uid": "35240-90079c23-57d4-4205-a08d-5387233071be" }, { "name": "View payment plans", "id": "46c146a2-e717-4b22-8e3e-b797b20732fd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.Nexhealth+json;version=2" } ], "url": { "raw": "{{baseUrl}}/payment_plans?subdomain=&location_id=&sort=&start_cursor=&end_cursor=&per_page=5&patient_id=&guarantor_id=&updated_since=", "host": [ "{{baseUrl}}" ], "path": [ "payment_plans" ], "query": [ { "description": "(Required) Used to scope the request to the specified institution", "key": "subdomain", "value": "" }, { "description": "(Required) Used to scope the request to the specified location", "key": "location_id", "value": "" }, { "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", "key": "sort", "value": "" }, { "description": "First item of the current page. Starts empty", "key": "start_cursor", "value": "" }, { "description": "Last item of the current page. Starts empty", "key": "end_cursor", "value": "" }, { "description": "Number of results to return per page. Maximum allowed amount is 1000.", "key": "per_page", "value": "5" }, { "description": "Filter by patient", "key": "patient_id", "value": "" }, { "description": "Filter by guarantor", "key": "guarantor_id", "value": "" }, { "description": "Filter for payment plans updated since a specific time", "key": "updated_since", "value": "" } ] } }, "response": [ { "id": "4705c576-c3cd-4299-b9c8-7ca3abc9c1e0", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.Nexhealth+json;version=2" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_plans?subdomain=&location_id=&sort=&start_cursor=&end_cursor=&per_page=5&patient_id=&guarantor_id=&updated_since=", "host": [ "{{baseUrl}}" ], "path": [ "payment_plans" ], "query": [ { "description": "(Required) Used to scope the request to the specified institution", "key": "subdomain", "value": "" }, { "description": "(Required) Used to scope the request to the specified location", "key": "location_id", "value": "" }, { "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", "key": "sort", "value": "" }, { "description": "First item of the current page. Starts empty", "key": "start_cursor", "value": "" }, { "description": "Last item of the current page. Starts empty", "key": "end_cursor", "value": "" }, { "description": "Number of results to return per page. Maximum allowed amount is 1000.", "key": "per_page", "value": "5" }, { "description": "Filter by patient", "key": "patient_id", "value": "" }, { "description": "Filter by guarantor", "key": "guarantor_id", "value": "" }, { "description": "Filter for payment plans updated since a specific time", "key": "updated_since", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.Nexhealth+json;version=2" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"error\": [\n \"\",\n \"\"\n ],\n \"data\": [\n {\n \"id\": \"\",\n \"patient_id\": \"\",\n \"guarantor_id\": \"\",\n \"first_payment_due_date\": \"\",\n \"created_date\": \"\",\n \"active\": \"\"\n },\n {\n \"id\": \"\",\n \"patient_id\": \"\",\n \"guarantor_id\": \"\",\n \"first_payment_due_date\": \"\",\n \"created_date\": \"\",\n \"active\": \"\"\n }\n ],\n \"page_info\": {}\n}", "createdAt": "2026-07-28T02:20:15.000Z", "updatedAt": "2026-07-28T02:20:15.000Z", "uid": "35240-4705c576-c3cd-4299-b9c8-7ca3abc9c1e0" }, { "id": "01f72907-db3f-4048-aba5-f3c2bbd4e195", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.Nexhealth+json;version=2" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_plans?subdomain=&location_id=&sort=&start_cursor=&end_cursor=&per_page=5&patient_id=&guarantor_id=&updated_since=", "host": [ "{{baseUrl}}" ], "path": [ "payment_plans" ], "query": [ { "description": "(Required) Used to scope the request to the specified institution", "key": "subdomain", "value": "" }, { "description": "(Required) Used to scope the request to the specified location", "key": "location_id", "value": "" }, { "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", "key": "sort", "value": "" }, { "description": "First item of the current page. Starts empty", "key": "start_cursor", "value": "" }, { "description": "Last item of the current page. Starts empty", "key": "end_cursor", "value": "" }, { "description": "Number of results to return per page. Maximum allowed amount is 1000.", "key": "per_page", "value": "5" }, { "description": "Filter by patient", "key": "patient_id", "value": "" }, { "description": "Filter by guarantor", "key": "guarantor_id", "value": "" }, { "description": "Filter for payment plans updated since a specific time", "key": "updated_since", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.Nexhealth+json;version=2" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:15.000Z", "updatedAt": "2026-07-28T02:20:15.000Z", "uid": "35240-01f72907-db3f-4048-aba5-f3c2bbd4e195" }, { "id": "90a465b1-99e2-45bf-a50f-4a3e2fddebed", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.Nexhealth+json;version=2" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_plans?subdomain=&location_id=&sort=&start_cursor=&end_cursor=&per_page=5&patient_id=&guarantor_id=&updated_since=", "host": [ "{{baseUrl}}" ], "path": [ "payment_plans" ], "query": [ { "description": "(Required) Used to scope the request to the specified institution", "key": "subdomain", "value": "" }, { "description": "(Required) Used to scope the request to the specified location", "key": "location_id", "value": "" }, { "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", "key": "sort", "value": "" }, { "description": "First item of the current page. Starts empty", "key": "start_cursor", "value": "" }, { "description": "Last item of the current page. Starts empty", "key": "end_cursor", "value": "" }, { "description": "Number of results to return per page. Maximum allowed amount is 1000.", "key": "per_page", "value": "5" }, { "description": "Filter by patient", "key": "patient_id", "value": "" }, { "description": "Filter by guarantor", "key": "guarantor_id", "value": "" }, { "description": "Filter for payment plans updated since a specific time", "key": "updated_since", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.Nexhealth+json;version=2" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:15.000Z", "updatedAt": "2026-07-28T02:20:15.000Z", "uid": "35240-90a465b1-99e2-45bf-a50f-4a3e2fddebed" }, { "id": "cf284f36-322c-495d-b004-57e37adbefb9", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.Nexhealth+json;version=2" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_plans?subdomain=&location_id=&sort=&start_cursor=&end_cursor=&per_page=5&patient_id=&guarantor_id=&updated_since=", "host": [ "{{baseUrl}}" ], "path": [ "payment_plans" ], "query": [ { "description": "(Required) Used to scope the request to the specified institution", "key": "subdomain", "value": "" }, { "description": "(Required) Used to scope the request to the specified location", "key": "location_id", "value": "" }, { "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", "key": "sort", "value": "" }, { "description": "First item of the current page. Starts empty", "key": "start_cursor", "value": "" }, { "description": "Last item of the current page. Starts empty", "key": "end_cursor", "value": "" }, { "description": "Number of results to return per page. Maximum allowed amount is 1000.", "key": "per_page", "value": "5" }, { "description": "Filter by patient", "key": "patient_id", "value": "" }, { "description": "Filter by guarantor", "key": "guarantor_id", "value": "" }, { "description": "Filter for payment plans updated since a specific time", "key": "updated_since", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.Nexhealth+json;version=2" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:15.000Z", "updatedAt": "2026-07-28T02:20:15.000Z", "uid": "35240-cf284f36-322c-495d-b004-57e37adbefb9" }, { "id": "6e6551b4-4fbd-44a8-9986-3d1d2237c30d", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.Nexhealth+json;version=2" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_plans?subdomain=&location_id=&sort=&start_cursor=&end_cursor=&per_page=5&patient_id=&guarantor_id=&updated_since=", "host": [ "{{baseUrl}}" ], "path": [ "payment_plans" ], "query": [ { "description": "(Required) Used to scope the request to the specified institution", "key": "subdomain", "value": "" }, { "description": "(Required) Used to scope the request to the specified location", "key": "location_id", "value": "" }, { "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", "key": "sort", "value": "" }, { "description": "First item of the current page. Starts empty", "key": "start_cursor", "value": "" }, { "description": "Last item of the current page. Starts empty", "key": "end_cursor", "value": "" }, { "description": "Number of results to return per page. Maximum allowed amount is 1000.", "key": "per_page", "value": "5" }, { "description": "Filter by patient", "key": "patient_id", "value": "" }, { "description": "Filter by guarantor", "key": "guarantor_id", "value": "" }, { "description": "Filter for payment plans updated since a specific time", "key": "updated_since", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.Nexhealth+json;version=2" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:15.000Z", "updatedAt": "2026-07-28T02:20:15.000Z", "uid": "35240-6e6551b4-4fbd-44a8-9986-3d1d2237c30d" } ], "createdAt": "2026-07-28T02:20:15.000Z", "updatedAt": "2026-07-28T02:20:15.000Z", "uid": "35240-46c146a2-e717-4b22-8e3e-b797b20732fd" } ], "id": "beb173a2-230f-4533-94af-299dda7a9a84", "createdAt": "2026-07-28T02:20:12.000Z", "updatedAt": "2026-07-28T02:20:12.000Z", "uid": "35240-beb173a2-230f-4533-94af-299dda7a9a84" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://nexhealth.info" } ] }