Get a price
- Sandbox: available
- On your own host? Choose https://{host} in the playground.
Reads one price, on the list or removed.
Scope: any member of the caller's project, with PATIENT_BILLING_ENABLED on.
Behaviour
statusisactivewhile the price is on the list andretiredonce removed.- A price your project does not hold answers 404
PRICE_NOT_FOUND.
Example
curl 'https://api.sandbox.ovok.com/v1/patient-billing/prices/<priceId>' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'bearerAuthorizationBearer <JWT>priceId*stringThe price id.
^[A-Za-z0-9\-.]{1,64}$The price, on the list or retired.
application/json- response
id*stringversion*stringSend it as If-Match: W/"<version>" to change only this version.
status*stringactive on the price list, retired once removed.
code*amount*The price of one unit.
period*curl -X GET 'https://api.sandbox.ovok.com/v1/patient-billing/prices/string'{ "id": "string", "version": "string", "status": "string", "code": { "system": "string", "code": "string", "display": "string" }, "amount": { "value": 0, "currency": "string" }, "period": { "start": "string", "end": "string" }}Set a price POST
Sets the price of one code: an app plan coding, or a care service code such as GOÄ or EBM. A code has one price in the project. **Scope:** a project admin or an admin ClientApplication, in a project with `PATIENT_BILLING_ENABLED` on. Anyone else: **403** `PATIENT_BILLING_NOT_ALLOWED`. ## Behaviour - A code without a price gets one: **201** with `Location: /v1/patient-billing/prices/<id>`. - A code with a price has it replaced: **200**. A removed price is back on the list. - `amount` is the price of one unit. `period` says from and until which day it applies; left out, it always applies. - A charge keeps the unit price it was entered at, so changing a price changes no charge already entered. ## Example ```bash curl -X POST 'https://api.sandbox.ovok.com/v1/patient-billing/prices' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \ -H 'Content-Type: application/json' \ -d '{ "code": { "system": "http://fhir.de/CodeSystem/kbv/ebm", "code": "03040", "display": "Zusatzpauschale Hausarzt" }, "amount": { "value": 15.81, "currency": "EUR" }, "period": { "start": "2026-01-01", "end": null } }' ```
Remove a price DELETE
Takes a price off the price list. New charges for its code then need a new price or a `priceOverride`. **Scope:** a project admin or an admin ClientApplication, in a project with `PATIENT_BILLING_ENABLED` on. Anyone else: **403** `PATIENT_BILLING_NOT_ALLOWED`. ## Behaviour - The price is retired, not deleted, so the charges entered at it still name it. Removing it again answers **204** too. - Setting the code's price again (`POST /v1/patient-billing/prices`) puts it back on the list. ## Example ```bash curl -X DELETE 'https://api.sandbox.ovok.com/v1/patient-billing/prices/<priceId>' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```