curl --request GET \
--url https://api.decodahealth.com/billing/charge/timeline \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'[
{
"id": "<string>",
"type": "CHARGE",
"amount": 123,
"date": "2023-11-07T05:31:56Z",
"paymentMethod": {
"id": "<string>",
"patientId": "<string>",
"rainforestPaymentMethodId": "<string>",
"brand": "<string>",
"last4": "<string>",
"expMonth": 123,
"expYear": 123,
"accountHolderType": "<string>",
"accountNumberLast4": 123,
"bankName": "<string>",
"routingNumber": 123,
"description": "<string>",
"type": "CARD",
"isDefault": false,
"isArchived": false
},
"paymentMedium": "<string>",
"status": "OUTSTANDING",
"comment": "<string>",
"description": "<string>",
"refundReason": "<string>",
"items": [
{
"chargeId": "<string>",
"quantity": 123,
"price": 123,
"id": "<string>",
"itemId": "<string>",
"name": "<string>",
"description": "<string>",
"discountAmount": 123,
"discountPercentage": 123,
"discountReason": "<string>",
"soldPackageId": "<string>",
"bankedQuantity": 123,
"bankedItemId": "<string>",
"issuedDiscountId": "<string>",
"soldByProviderId": "<string>",
"taxAmount": 123,
"pricingId": "<string>",
"shipmentIds": [
"<string>"
],
"item": {
"name": "<string>",
"price": 123,
"id": "<string>",
"brandName": "<string>",
"description": "<string>",
"category": "<string>",
"unit": "AMPOULES",
"isPhysical": true,
"isArchived": false,
"internalNotes": "<string>",
"taxable": false,
"sortOrder": 123,
"allowCustomPricing": false,
"type": "PRODUCT"
},
"locationId": "<string>",
"locationName": "<string>",
"saleDate": "2023-11-07T05:31:56Z"
}
],
"discountAmount": 123,
"creator": {
"id": "<string>",
"type": "PROVIDER",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>"
},
"feeToPatient": 123,
"tips": [
{
"chargeId": "<string>",
"amount": 123,
"providerId": "<string>",
"id": "<string>",
"provider": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
}
}
]
}
]Get a timeline of events for a specific charge or payment. This will include all related charges, payments, adjustments, and refunds.
curl --request GET \
--url https://api.decodahealth.com/billing/charge/timeline \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'[
{
"id": "<string>",
"type": "CHARGE",
"amount": 123,
"date": "2023-11-07T05:31:56Z",
"paymentMethod": {
"id": "<string>",
"patientId": "<string>",
"rainforestPaymentMethodId": "<string>",
"brand": "<string>",
"last4": "<string>",
"expMonth": 123,
"expYear": 123,
"accountHolderType": "<string>",
"accountNumberLast4": 123,
"bankName": "<string>",
"routingNumber": 123,
"description": "<string>",
"type": "CARD",
"isDefault": false,
"isArchived": false
},
"paymentMedium": "<string>",
"status": "OUTSTANDING",
"comment": "<string>",
"description": "<string>",
"refundReason": "<string>",
"items": [
{
"chargeId": "<string>",
"quantity": 123,
"price": 123,
"id": "<string>",
"itemId": "<string>",
"name": "<string>",
"description": "<string>",
"discountAmount": 123,
"discountPercentage": 123,
"discountReason": "<string>",
"soldPackageId": "<string>",
"bankedQuantity": 123,
"bankedItemId": "<string>",
"issuedDiscountId": "<string>",
"soldByProviderId": "<string>",
"taxAmount": 123,
"pricingId": "<string>",
"shipmentIds": [
"<string>"
],
"item": {
"name": "<string>",
"price": 123,
"id": "<string>",
"brandName": "<string>",
"description": "<string>",
"category": "<string>",
"unit": "AMPOULES",
"isPhysical": true,
"isArchived": false,
"internalNotes": "<string>",
"taxable": false,
"sortOrder": 123,
"allowCustomPricing": false,
"type": "PRODUCT"
},
"locationId": "<string>",
"locationName": "<string>",
"saleDate": "2023-11-07T05:31:56Z"
}
],
"discountAmount": 123,
"creator": {
"id": "<string>",
"type": "PROVIDER",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>"
},
"feeToPatient": 123,
"tips": [
{
"chargeId": "<string>",
"amount": 123,
"providerId": "<string>",
"id": "<string>",
"provider": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
}
}
]
}
]The tenant you are making this request on behalf of
Your api key
Successful Response
CHARGE, PAYMENT, REFUND, VOID, ADJUSTMENT, EXTERNAL_SETTLEMENT, WRITE_OFF, SCHEDULED_PAYMENT, FAILED_PAYMENT Show child attributes
CARD, ACH, APPLE_PAY OUTSTANDING, PAID, EXTERNAL_SETTLEMENT, VOID, WRITE_OFF, REFUNDED, CHARGEBACK, PAYMENT_PLAN, COLLECTIONS Show child attributes
Identifier of the charge this item is associated with
Quantity of the item being charged
Price of the item in cents
Unique identifier for the charge item
Optional unique identifier for the item
Name of the item (None for items with associated inventory item)
Description of the item
Discount amount for the item
Discount percentage for the item
Reason for discount
Unique identifier for the sold package usage
Quantity to bank for later use
ID of banked item being used (for tracking usage)
Unique identifier for the specific issued discount instance used
Unique identifier for the provider who sold the item
Tax amount for the item in cents
Unique identifier for the pricing for the item
Optional list of shipment IDs to reduce the stock quantity of
Details of the item (None for custom charge items)
Show child attributes
Name of the item
Price of the item in cents
Unique identifier for the item
Optional brand name of the item
Optional description of the item
Category name (references category.name)
Unit of measurement for the item
AMPOULES, APPLICATORS, BOTTLES, BOXES, CAPSULES, CUPS, DOSES, G_PER_ML, GRAMS, IU, IU_PER_ML, OUNCES, FLUID_OUNCES, KG, KITS, LITERS, MCG, MG, MG_PER_ML, ML, MMOL, MICROGRAM_PER_ML, PACKS, PAIRS, PATCHES, PERCENTAGE, PIECES, POUCHES, ROLLS, SACHETS, SHEETS, SPRAYS, STRIPS, SYRINGES, TABLETS, TABLETS_PER_DAY, TESTS, TUBES, UNITS, VIALS, TREATMENTS, SESSIONS, PULSES, JOULES, CENTIMETERS, THREAD_COUNT, INJECTIONS, WRINKLE_UNITS, POUNDS, FEET, INCHES Whether the item is physical
Whether the item is archived
Optional internal notes for the item
Whether the item is subject to taxes
Optional sort order for the item
Whether custom pricing is allowed for this item
Type of item (PRODUCT, MEDICATION, etc.)
ITEM, PRODUCT, MEDICATION, SERVICE, PACKAGE, MEMBERSHIP Location ID where the sale occurred
Location name where the sale occurred
Date when the sale occurred
Show child attributes
The unique identifier for the user.
The type of user.
PROVIDER, PATIENT, ASSISTANT The user's first name.
The user's last name.
The user's phone number.
The user's email address.
The location of the user.
Show child attributes
Charge ID this tip belongs to
Tip amount in cents
Provider ID receiving the tip
Unique identifier for the tip