POST/api/v1/workspaces/{workspaceId}/health-invoices/{invoiceId}/reconciliations

**Operation ID:** `healthInvoices.reconcile` · **Access:** PAT with `send` scope and authorized workspace where applicable · **Effect:** `external`. :::caution[Production action] This operation can send data to an external service. Use a new idempotency key for each new intent. A timeout does not prove that the action failed. ::: An `Idempotency-Key` is **required**. Retry the same intent with the same key and the same request bytes. [Read the retry rules](/guides/errors-and-retries/). Read the [health invoices workflow](/guides/health-documents/) before this operation. ## Parameters | Name | In | Required | Type / allowed values | | --- | --- | --- | --- | | `workspaceId` | path | Yes | string | | `invoiceId` | path | Yes | string | | `idempotency-key` | header | Yes | string | ## Request body **Content type:** `application/json` · **Required:** yes. Schema: [ReconcileHealthDocumentInput](/reference/schemas/reconcile-health-document-input/). [Browse schema fields](/reference/schemas/).

Example: knownProviderId

Synthetic contract example. Replace identifiers and clinical data with authorized values. This example does not prove ministry acceptance. [Download JSON](/examples/health-invoices-reconcile-knownProviderId.json) ```json { "providerDocumentId": "11111111-1111-4111-8111-111111111111" } ```

## Responses | HTTP | Content | Schema | | --- | --- | --- | | 200 | `application/json` | [HealthInvoice](/reference/schemas/health-invoice/) | | 400 | `application/json` | [ApiError](/reference/schemas/api-error/) | | 401 | `application/json` | [ApiError](/reference/schemas/api-error/) | | 403 | `application/json` | [ApiError](/reference/schemas/api-error/) | | 404 | `application/json` | [ApiError](/reference/schemas/api-error/) | | 409 | `application/json` | [ApiError](/reference/schemas/api-error/) | | 413 | `application/json` | [ApiError](/reference/schemas/api-error/) | | 415 | `application/json` | [ApiError](/reference/schemas/api-error/) | | 422 | `application/json` | [ApiError](/reference/schemas/api-error/) | | 428 | `application/json` | [ApiError](/reference/schemas/api-error/) | | 500 | `application/json` | [ApiError](/reference/schemas/api-error/) | | 502 | `application/json` | [ApiError](/reference/schemas/api-error/) | Use `error.code`, `error.issues`, and `requestId` for JSON errors. [Error and recovery guide](/guides/errors-and-retries/). ## cURL Set the connection variables from the [quickstart](/guides/quickstart/). Set each path variable to an authorized identifier or an allowed parameter value from the table above. Save your authorized JSON input as `request.json`. Use the request schema and examples above; replace synthetic data before use. Set `IDEMPOTENCY_KEY` to a unique key for this intent. Preserve it and the exact request for retries. ```bash curl --fail-with-body --request POST \ "$RIPSCLOUD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/health-invoices/$INVOICE_ID/reconciliations" \ --header "Authorization: Bearer $RIPSCLOUD_TOKEN" \ --header 'Accept: application/json' \ --header "Idempotency-Key: $IDEMPOTENCY_KEY" \ --header 'Content-Type: application/json' \ --data-binary @request.json ```