Remove a price
- Sandbox: available
- On your own host? Choose https://{host} in the playground.
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
curl -X DELETE '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}$Off the price list: retired, so the charges entered at it still name it.
curl -X DELETE 'https://api.sandbox.ovok.com/v1/patient-billing/prices/string'Get a price GET
Reads one price, on the list or removed. **Scope:** any member of the caller's project, with `PATIENT_BILLING_ENABLED` on. ## Behaviour - `status` is `active` while the price is on the list and `retired` once removed. - A price your project does not hold answers **404** `PRICE_NOT_FOUND`. ## Example ```bash curl 'https://api.sandbox.ovok.com/v1/patient-billing/prices/<priceId>' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```
List a patient's charges GET
Lists the patient's charges, latest service first, a page at a time. **Scope:** the caller's project, with `PATIENT_BILLING_ENABLED` on. ## Behaviour - Your access policy must grant `patient_billing_charges` `read` and let you read the patient, else **403** `PATIENT_BILLING_NOT_ALLOWED` or **404** `PATIENT_BILLING_PATIENT_NOT_FOUND`. - `clinicId` lists only that clinic's charges. Every status is listed; `status` says which are still `billable`. - `limit` is 1 to 100 (30 when left out). Send `nextCursor` back as `cursor` for the next page; a cursor no page gave answers **400** `PATIENT_BILLING_CURSOR_INVALID`. ## Example ```bash curl 'https://api.sandbox.ovok.com/v1/patient-billing/patients/<patientId>/charges?clinicId=<clinicId>' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```