---
title: "Update Charge Capture"
method: PATCH
path: "/api/charge_captures/v1/{charge_capture_id}"
tags: ["v1"]
---

# Update Charge Capture

`PATCH /api/charge_captures/v1/{charge_capture_id}`

## Path parameters

- `charge_capture_id` string, uuid, required

## Headers

- `Authorization` string, required

## Request body

- object
  - `data` V1ChargeCaptureData — unresolved $ref
  - `charge_external_id` string — A client-specified unique ID to associate with this encounter; for example, your internal encounter ID or a Dr. Chrono encounter ID. This field should not contain PHI.
  - `ehr_source_url` string — External URL reference that links to Charge Capture details within the external system (e.g. the EHR visit page). Send full URL format for the external link (e.g. https://emr_charge_capture_url.com/123).
  - `originating_system` string — An optional string field denoting the originating system of the charge.
  - `claim_creation_category` string — An optional string field denoting the user defined category of the claim creation.
  - `patient_external_id` string — The patient ID from the external EMR platform for the patient
  - `status` V1ChargeCaptureStatus — unresolved $ref
  - `attachment_external_document_ids` string[] — Provide external attachment IDs which have been uploaded to Candid. They will be associated with the Encounter at Encounter creation time.
  - `metadata` V1SchemaInstance[] — Key-value pairs that adhere to metadata schemas. Multiple metadata instances can be associated with a charge capture. — unresolved $ref
  - `hl7_message_type` V1Hl7MessageType — unresolved $ref

## Response `200`

Response with status 200

- V1ChargeCapture — unresolved $ref

## Other responses

- `403` — Error response with status 403
- `404` — Error response with status 404
- `422` — Error response with status 422

---

[API](https://skmtc.net/joincandidhealth/apis/api-reference.md) · [All operations](https://skmtc.net/joincandidhealth/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/joincandidhealth/api-reference/revisions/7cc5974e4128/schema)