{ "opencollection": "1.0.0", "info": { "name": "API Reference subpackage_auth.subpackage_auth/default subpackage_write-offs.subpackage_write-offs/v1 API", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_write-offs.subpackage_write-offs/v1", "type": "folder" }, "items": [ { "info": { "name": "Get all write-offs", "type": "http" }, "http": { "method": "GET", "url": "https://pre-api.joincandidhealth.com/api/write-offs/v1", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "Defaults to 100. The value must be greater than 0 and less than 1000." }, { "name": "patient_external_id", "value": "", "type": "query" }, { "name": "payer_uuid", "value": "", "type": "query" }, { "name": "service_line_id", "value": "", "type": "query" }, { "name": "claim_id", "value": "", "type": "query" }, { "name": "billing_provider_id", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query", "description": "Defaults to write_off_timestamp" }, { "name": "sort_direction", "value": "", "type": "query", "description": "Sort direction. Defaults to descending order if not provided." }, { "name": "page_token", "value": "", "type": "query" }, { "name": "account_types", "value": "", "type": "query", "description": "Filters the returned values to include only the provided account types." } ] }, "docs": "Returns all write-offs satisfying the search criteria." }, { "info": { "name": "Create write-off", "type": "http" }, "http": { "method": "POST", "url": "https://pre-api.joincandidhealth.com/api/write-offs/v1", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates one or many write-offs applied toward a specific service line,\nclaim, or billing provider." }, { "info": { "name": "Get write-off", "type": "http" }, "http": { "method": "GET", "url": "https://pre-api.joincandidhealth.com/api/write-offs/v1/:write_off_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "write_off_id", "value": "", "type": "path" } ] }, "docs": "Retrieves a previously created write off by its `write_off_id`." }, { "info": { "name": "Revert write-off", "type": "http" }, "http": { "method": "POST", "url": "https://pre-api.joincandidhealth.com/api/write-offs/v1/:write_off_id/revert", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "write_off_id", "value": "", "type": "path" } ] }, "docs": "Reverts a write off given a `write_off_id`." }, { "info": { "name": "Revert Insurance Balance Adjustment", "type": "http" }, "http": { "method": "POST", "url": "https://pre-api.joincandidhealth.com/api/write-offs/v1/:adjustment_id/revert", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "adjustment_id", "value": "", "type": "path" } ] }, "docs": "Reverts an Insurance Balance Adjustment given an `adjustment_id`" }, { "info": { "name": "Revert ERA-originated Insurance Balance Adjustment", "type": "http" }, "http": { "method": "POST", "url": "https://pre-api.joincandidhealth.com/api/write-offs/v1/:adjustment_id/revert-era-originated", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "adjustment_id", "value": "", "type": "path" } ] }, "docs": "Reverts an ERA-originated Insurance Balance Adjustment given an `adjustment_id`" } ] } ], "bundled": true }