Get Rate History

GET

/api/fee-schedules/v3/:rate_id/history

GET

1 import uuid
2 
3 from candid import CandidApiClient
4 
5 client = CandidApiClient(
6     client_id="YOUR_CLIENT_ID",
7     client_secret="YOUR_CLIENT_SECRET",
8 )
9 client.fee_schedules.v_3.get_rate_history(
10     rate_id=uuid.UUID(
11         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
12     ),
13 )

Play

200Retrieved

1 [
2   {
3     "rate_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
4     "dimensions": {
5       "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
6       "organization_billing_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
7       "states": [
8         "AA"
9       ],
10       "zip_codes": [
11         "string"
12       ],
13       "license_types": [
14         "MD"
15       ],
16       "facility_type_codes": [
17         "01"
18       ],
19       "network_types": [
20         "12"
21       ],
22       "payer_plan_group_ids": [
23         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
24       ],
25       "cpt_code": "string",
26       "modifiers": [
27         "22"
28       ]
29     },
30     "version": 0,
31     "updated_at": "2023-01-01",
32     "updated_by": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
33     "entries": [
34       {
35         "start_date": "2023-01-01",
36         "rate_cents": 0,
37         "is_deactivated": true,
38         "end_date": "2023-01-01"
39       }
40     ]
41   }
42 ]

Gets every version of a rate.

Path parameters

rate_idUUIDRequired

Headers

AuthorizationstringRequired

OAuth authentication of the form <token>.

Response

This endpoint returns a list of objects.

rate_idUUID

dimensionsobject

The dimension values that distinguish this rate from others.

versioninteger

The version of this rate in the system.

updated_atdate

updated_byUUID

entrieslist of objects

Path parameters

Headers

Response

Errors