v1

latestOpenAPI 3.1.02026-08-0452419.0 KB
purchases

Get a single purchase

get/purchases/{purchase_id}

Path parameters

purchase_idstring uuid required

Headers

Authorizationstring required

Production machine-to-machine flow. Tokens issued by Descope.

Response

A single purchase.

purchase_idstring uuid required

Andel-issued unique identifier.

member_idstring required

Plan or PBM member identifier.

plan_idstring required

Plan that the member belongs to. Each member belongs to exactly one plan. Tokens are scoped to a set of allowed plan IDs; purchases for plans outside that set are not returned.

purchased_atstring date-time required

ISO 8601 UTC timestamp from the pharmacy point-of-sale.

ndcstring

11-digit National Drug Code.

prescriber_spistring

Surescripts Prescriber ID.

member_purchase_amountnumber double

(Proposed - provenance pending) Total amount the member paid at point-of-sale, USD.

oop_amountnumber double

(Proposed - provenance pending) Member out-of-pocket portion, USD.

plan_contributionnumber double

(Proposed - provenance pending) Plan's portion of the purchase (the plan contribution), USD.

quantityinteger

Units dispensed.

currencystring required

ISO 4217 currency code.

date_of_servicestring date required

The actual fill date used for eligibility validation. Distinct from purchased_at, which is the point-of-sale timestamp.

days_supplyinteger

Days of therapy the dispensed quantity covers.

provider_type'ncpdp' | 'npi' | 'dea' | 'copay_assist'

Qualifier describing which provider identifier is carried in the provider slot.

pharmacy_npistring

Dispensing pharmacy identifier, when provided.

network_ind'in_network' | 'out_of_network' | 'both' | 'inn_house'

Whether the fill adjudicated in- or out-of-network.

event_type'claim' | 'reversal' | 'adjustment' | 'hra_initial_load' | 'hra_rollover' | 'hra_incentive' required

The kind of accumulator event. claim is a normal fill; reversal restores accumulators for a returned or voided fill; adjustment is a flat or paired correction.

original_purchase_idstring uuid nullable

For reversals or adjustments, the purchase_id of the purchase being corrected. Null for new purchases.

status'accepted' | 'rejected' | 'pended' | 'reversed'

Processing status of the purchase.

deductible_appliednumber double

(Proposed - provenance pending) Amount of this purchase applied to the member's deductible, USD.

subscriber_idstring

The member's subscriber identifier at the PBM's eligibility system. Distinct from member_id.

first_namestring

Member first name.

last_namestring

Member last name.

date_of_birthstring date

Member date of birth.

gender'unknown' | 'male' | 'female' | 'non_binary'

Member gender as carried to the PBM.

relationship'subscriber' | 'spouse' | 'dependent' | 'student' | 'disabled_dependent' | 'adult_dependent' | 'domestic_partner'

Member's relationship to the subscriber.

origin_code'E' | 'R'

ESI origin code for HRA balance events (hra_initial_load, hra_rollover, hra_incentive); E is a non-shared pharmacy dollars load. Omitted for pharmacy fills.

plan_yearinteger

Plan year the balance applies to. Used for HRA balance events.