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,
"restrictedToMerchantId": "<string>"
},
"paymentMedium": "<string>",
"status": "OUTSTANDING",
"comment": "<string>",
"description": "<string>",
"refundReason": "<string>",
"items": [
{
"quantity": 123,
"price": 123,
"id": "<string>",
"itemId": "<string>",
"chargeId": "<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>",
"sortOrder": 123,
"allowCustomPricing": false,
"type": "PRODUCT",
"externalId": "<string>",
"exemptedTaxIds": [
"<string>"
]
},
"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,
"restrictedToMerchantId": "<string>"
},
"paymentMedium": "<string>",
"status": "OUTSTANDING",
"comment": "<string>",
"description": "<string>",
"refundReason": "<string>",
"items": [
{
"quantity": 123,
"price": 123,
"id": "<string>",
"itemId": "<string>",
"chargeId": "<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>",
"sortOrder": 123,
"allowCustomPricing": false,
"type": "PRODUCT",
"externalId": "<string>",
"exemptedTaxIds": [
"<string>"
]
},
"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
OUTSTANDING, PAID, EXTERNAL_SETTLEMENT, VOID, WRITE_OFF, REFUNDED, CHARGEBACK, PAYMENT_PLAN, COLLECTIONS Show child attributes
Show child attributes
Show child attributes