# ovok_sdk.resources.patient_billing

Canonical page: https://docs.ovok.com/python-sdk/reference/resources/patient_billing

The `ovok.patient_billing` namespace: patients' insurance, plans, billing accounts and invoices.

## PatientBillingInsurersResource [#patientbillinginsurersresource]

```python
PatientBillingInsurersResource(billing: HttpClient)
```

Insurers a coverage may name; access it as `ovok.patient_billing.insurers`.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `billing` | `HttpClient` |  | The HTTP client scoped to the patient billing routes. |

### list() [#list]

```python
list(
    params: JsonObject | None = None,
    *,
    options: RequestOptions | None = None,
) -> list[Any]
```

Find insurers.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `params` | `JsonObject \| None` | `None` | Optional `country` (`DE`), `kind` (`statutory` or `private`) and `query` text. |
| `options` | `RequestOptions \| None` | `None` | Per-request options; `timeout` overrides the client's. |

**Returns**

- `list[Any]`: The insurers.

## PatientBillingCoveragesResource [#patientbillingcoveragesresource]

```python
PatientBillingCoveragesResource(billing: HttpClient)
```

Patients' health insurance; access it as `ovok.patient_billing.coverages`.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `billing` | `HttpClient` |  | The HTTP client scoped to the patient billing routes. |

### list() [#list-1]

```python
list(patient_id: str, *, options: RequestOptions | None = None) -> list[Any]
```

List a patient's coverages.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `patient_id` | `str` |  | The Patient's ID. |
| `options` | `RequestOptions \| None` | `None` | Per-request options; `timeout` overrides the client's. |

**Returns**

- `list[Any]`: The coverages, in their `order`.

### create() [#create]

```python
create(
    patient_id: str,
    body: JsonObject,
    *,
    options: RequestOptions | None = None,
) -> Any
```

Add a coverage to a patient.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `patient_id` | `str` |  | The Patient's ID. |
| `body` | `JsonObject` |  | The coverage: its `kind` (`statutory`, `private` or `self-pay`) and the insurer and member number that kind needs. |
| `options` | `RequestOptions \| None` | `None` | Per-request options; `timeout` overrides the client's. |

**Returns**

- `Any`: The coverage.

### update() [#update]

```python
update(
    coverage_id: str,
    changes: JsonObject,
    *,
    if_version: str | None = None,
    options: RequestOptions | None = None,
) -> Any
```

Change a coverage.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `coverage_id` | `str` |  | The coverage ID. |
| `changes` | `JsonObject` |  | The fields to change. |
| `if_version` | `str \| None` | `None` | The `version` you read; a coverage changed since is refused with `OvokConflictError`. |
| `options` | `RequestOptions \| None` | `None` | Per-request options; `timeout` overrides the client's. |

**Returns**

- `Any`: The coverage after the change.

### remove() [#remove]

```python
remove(coverage_id: str, *, options: RequestOptions | None = None) -> None
```

Remove a coverage.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `coverage_id` | `str` |  | The coverage ID. |
| `options` | `RequestOptions \| None` | `None` | Per-request options; `timeout` overrides the client's. |

## PatientBillingPlansResource [#patientbillingplansresource]

```python
PatientBillingPlansResource(billing: HttpClient)
```

The plan each patient pays for; access it as `ovok.patient_billing.plans`.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `billing` | `HttpClient` |  | The HTTP client scoped to the patient billing routes. |

### retrieve() [#retrieve]

```python
retrieve(patient_id: str, *, options: RequestOptions | None = None) -> Any
```

Read a patient's plan.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `patient_id` | `str` |  | The Patient's ID. |
| `options` | `RequestOptions \| None` | `None` | Per-request options; `timeout` overrides the client's. |

**Returns**

- `Any`: The plan.

### set() [#set]

```python
set(
    patient_id: str,
    body: JsonObject,
    *,
    options: RequestOptions | None = None,
) -> Any | None
```

Set or end a patient's plan.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `patient_id` | `str` |  | The Patient's ID. |
| `body` | `JsonObject` |  | `plan` (a coding, or None to end it) and an optional `period`. |
| `options` | `RequestOptions \| None` | `None` | Per-request options; `timeout` overrides the client's. |

**Returns**

- `Any | None`: The plan, or None when `plan` was None.

## PatientBillingAccountsResource [#patientbillingaccountsresource]

```python
PatientBillingAccountsResource(billing: HttpClient)
```

Patients' billing accounts; access it as `ovok.patient_billing.accounts`.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `billing` | `HttpClient` |  | The HTTP client scoped to the patient billing routes. |

### list() [#list-2]

```python
list(patient_id: str, *, options: RequestOptions | None = None) -> list[Any]
```

List a patient's billing accounts.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `patient_id` | `str` |  | The Patient's ID. |
| `options` | `RequestOptions \| None` | `None` | Per-request options; `timeout` overrides the client's. |

**Returns**

- `list[Any]`: The accounts.

### retrieve() [#retrieve-1]

```python
retrieve(account_id: str, *, options: RequestOptions | None = None) -> Any
```

Read one billing account.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `account_id` | `str` |  | The account ID. |
| `options` | `RequestOptions \| None` | `None` | Per-request options; `timeout` overrides the client's. |

**Returns**

- `Any`: The account.

## PatientBillingInvoicesResource [#patientbillinginvoicesresource]

```python
PatientBillingInvoicesResource(billing: HttpClient)
```

Patients' invoices; access it as `ovok.patient_billing.invoices`.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `billing` | `HttpClient` |  | The HTTP client scoped to the patient billing routes. |

### list() [#list-3]

```python
list(
    patient_id: str,
    params: JsonObject | None = None,
    *,
    options: RequestOptions | None = None,
) -> Page[Any]
```

List a patient's invoices.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `patient_id` | `str` |  | The Patient's ID. |
| `params` | `JsonObject \| None` | `None` | Optional `limit` per page. |
| `options` | `RequestOptions \| None` | `None` | Per-request options; `timeout` overrides the client's. |

**Returns**

- `Page[Any]`: A page of invoices that loads later pages on demand.

### retrieve() [#retrieve-2]

```python
retrieve(invoice_id: str, *, options: RequestOptions | None = None) -> Any
```

Read one invoice.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `invoice_id` | `str` |  | The invoice ID. |
| `options` | `RequestOptions \| None` | `None` | Per-request options; `timeout` overrides the client's. |

**Returns**

- `Any`: The invoice.

### record() [#record]

```python
record(
    patient_id: str,
    body: JsonObject,
    *,
    options: RequestOptions | None = None,
) -> Any
```

Record an invoice issued elsewhere; the same `identifier` again answers the same invoice.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `patient_id` | `str` |  | The Patient's ID. |
| `body` | `JsonObject` |  | `identifier`, `status`, `issuedAt`, `lines` and optional `total` and `cancelledReason`. |
| `options` | `RequestOptions \| None` | `None` | Per-request options; `timeout` overrides the client's. |

**Returns**

- `Any`: The invoice.

## PatientBillingResource [#patientbillingresource]

```python
PatientBillingResource(http: HttpClient)
```

Patients' health insurance, plans, billing accounts and invoices.

Created by `Ovok`; access it as `ovok.patient_billing`.
