> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.joincandidhealth.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.joincandidhealth.com/_mcp/server. # Get patient refunds GET https://api.joincandidhealth.com/api/patient-refunds/v1 Returns all patient refunds satisfying the search criteria AND whose organization_id matches the current organization_id of the authenticated user. Reference: https://docs.joincandidhealth.com/api-reference/patient-collections/patient-refunds/v-1/get-multi ## Authentication - OAuth2 — send the obtained token as `Authorization: Bearer ` ## Servers - `https://api.joincandidhealth.com` (Production, default) - `https://api-staging.joincandidhealth.com` (Staging) - `https://sandbox-api.joincandidhealth.com` (CandidSandbox) - `https://staging-api.joincandidhealth.com` (CandidStaging) - `http://localhost:5050` (Local) ## Request ### Query parameters - `limit` (integer, optional) — Defaults to 100. The value must be greater than 0 and less than 1000. - `patient_external_id` (string, optional) - `claim_id` (UUID, optional) - `service_line_id` (UUID, optional) - `billing_provider_id` (UUID, optional) - `unattributed` (boolean, optional) — returns payments with unattributed allocations if set to true - `invoice_id` (UUID, optional) - `sources` (enum, optional) - Allowed values: `MANUAL_ENTRY`, `CHARGEBEE`, `SQUARE`, `STRIPE`, `ELATION`, `CEDAR`, `HEALTHIE`, `REALLOCATION`, `PHREESIA`, `INSTAMED`, `SHERPA_HEALTH`, `LOCKBOX` - `sort` (enum, optional) — Defaults to refund_timestamp - Allowed values: `refund_source`, `amount_cents`, `refund_timestamp`, `refund_reason`, `refund_note` - `sort_direction` (enum, optional) — Sort direction. Defaults to descending order if not provided. - Allowed values: `asc`, `desc` - `page_token` (string, optional) ## Response ### 200 - `items` (list of PatientRefund, required) - `next_page_token` (string, optional) - `prev_page_token` (string, optional) ## Errors ### 403 Unauthorized Error - `errorName` ("UnauthorizedError", required) - `content` (UnauthorizedErrorMessage, required) ### 422 Unprocessable Entity Error - `errorName` ("UnprocessableEntityError", required) - `content` (UnprocessableEntityErrorMessage, required) ## Types ### PatientRefund - `patient_refund_id` (UUID, required) - `organization_id` (UUID, required) - `refund_source` (enum, required) - Allowed values: `MANUAL_ENTRY`, `CHARGEBEE`, `SQUARE`, `STRIPE`, `ELATION`, `CEDAR`, `HEALTHIE`, `REALLOCATION`, `PHREESIA`, `INSTAMED`, `SHERPA_HEALTH`, `LOCKBOX` - `amount_cents` (integer, required) - `patient_external_id` (string, required) - `allocations` (list of Allocation, required) - `source_internal_id` (string, optional) - `refund_timestamp` (datetime, optional) - `refund_note` (string, optional) - `invoice` (UUID, optional) - `refund_reason` (enum, optional) - Allowed values: `OVERCHARGED`, `ENTERED_IN_ERROR`, `TRANSFER` ### UnauthorizedErrorMessage - `message` (string, optional) ### UnprocessableEntityErrorMessage - `message` (string, optional) ### Allocation - `amount_cents` (integer, required) - `target` (AllocationTarget, required) — Allocation targets describe whether the portion of a payment is being applied toward a specific service line, claim, billing provider, or is unallocated. - `allocation_id` (UUID, optional) - `earmark` (BalanceEarmark, optional) — The active earmark created by this allocation, if any. Only present when this allocation created an earmark for future auto-allocation and the earmark has not been deleted. - `allocated_on` (datetime, optional) ### AllocationTarget Allocation targets describe whether the portion of a payment is being applied toward a specific service line, claim, billing provider, or is unallocated. - `type`: `service_line` - `claim_id` (UUID, required) - `encounter_id` (UUID, required) - `service_line_id` (UUID, required) - `type`: `claim` - `claim_id` (UUID, required) - `encounter_id` (UUID, required) - `type`: `billing_provider_id` - `billing_provider_id` (UUID, required) - `type`: `appointment` - `appointment_id` (string, required) - `patient_external_id` (string, required) - `type`: `unattributed` ### BalanceEarmark Represents an active balance earmarking record that holds allocated funds for future auto-allocation. Earmarks are created when funds are allocated but should be held for a specific encounter or date of service. Only active (non-deleted) earmarks are returned. - `id` (UUID, required) - `target` (AllocationEarmarkType, required) — The target for this earmark (date of service or external encounter ID) - `amount_earmarked_cents` (integer, optional) — The amount earmarked in cents for future allocation - `created_by_allocation_id` (UUID, optional) — The ID of the allocation that created this earmark ### AllocationEarmarkType If enabled for your organization, defines how a patient prepayment allocation should be earmarked for future auto-allocation. Earmarks hold the allocation until a matching encounter is created, then attempt to allocate to that encounter. Only applicable for unattributed allocations. - `type`: `date_of_service` - `value` (string, required) — ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01) - `type`: `external_encounter_id` - `value` (string, required) ## Examples **Response** ```json { "items": [ { "patient_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "refund_source": "MANUAL_ENTRY", "amount_cents": 1, "patient_external_id": "patient_external_id", "allocations": [ { "amount_cents": 1, "target": { "type": "service_line", "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, "allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "earmark": { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "target": { "type": "date_of_service", "value": "target" }, "amount_earmarked_cents": 1, "created_by_allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, "allocated_on": "2024-01-15T09:30:00Z" }, { "amount_cents": 1, "target": { "type": "service_line", "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, "allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "earmark": { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "target": { "type": "date_of_service", "value": "target" }, "amount_earmarked_cents": 1, "created_by_allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, "allocated_on": "2024-01-15T09:30:00Z" } ], "source_internal_id": "source_internal_id", "refund_timestamp": "2024-01-15T09:30:00Z", "refund_note": "refund_note", "invoice": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "refund_reason": "OVERCHARGED" }, { "patient_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "refund_source": "MANUAL_ENTRY", "amount_cents": 1, "patient_external_id": "patient_external_id", "allocations": [ { "amount_cents": 1, "target": { "type": "service_line", "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, "allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "earmark": { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "target": { "type": "date_of_service", "value": "target" }, "amount_earmarked_cents": 1, "created_by_allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, "allocated_on": "2024-01-15T09:30:00Z" }, { "amount_cents": 1, "target": { "type": "service_line", "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, "allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "earmark": { "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "target": { "type": "date_of_service", "value": "target" }, "amount_earmarked_cents": 1, "created_by_allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, "allocated_on": "2024-01-15T09:30:00Z" } ], "source_internal_id": "source_internal_id", "refund_timestamp": "2024-01-15T09:30:00Z", "refund_note": "refund_note", "invoice": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "refund_reason": "OVERCHARGED" } ], "next_page_token": "next_page_token", "prev_page_token": "prev_page_token" } ``` **SDK Code** ```python import requests url = "https://api.joincandidhealth.com/api/patient-refunds/v1" headers = {"Authorization": "."} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.joincandidhealth.com/api/patient-refunds/v1'; const options = {method: 'GET', headers: {Authorization: '.'}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.joincandidhealth.com/api/patient-refunds/v1" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", ".") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.joincandidhealth.com/api/patient-refunds/v1") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = '.' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.joincandidhealth.com/api/patient-refunds/v1") .header("Authorization", ".") .asString(); ``` ```php request('GET', 'https://api.joincandidhealth.com/api/patient-refunds/v1', [ 'headers' => [ 'Authorization' => '.', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.joincandidhealth.com/api/patient-refunds/v1"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "."); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "."] let request = NSMutableURLRequest(url: NSURL(string: "https://api.joincandidhealth.com/api/patient-refunds/v1")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```