Get Charges Table
curl --request GET \
--url https://api.decodahealth.com/billing/charge/table \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'{
"data": [
{
"id": "<string>",
"total": 123,
"totalOutstanding": 123,
"patient": {
"id": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>",
"externalId": "<string>",
"address": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"addressValid": true,
"meta": {},
"isArchived": true,
"primaryLocationId": "<string>",
"gender": "<string>",
"dateOfBirth": "2023-12-25",
"patientMedications": [
"<string>"
],
"onSchedulingBlacklist": true,
"surchargeDisabled": true,
"tags": [
{
"id": "<string>",
"name": "<string>",
"isActive": true,
"createdDate": "2023-11-07T05:31:56Z",
"emoji": "<string>",
"color": "<string>",
"updatedDate": "2023-11-07T05:31:56Z"
}
],
"creditBalance": 123,
"preferredProviderId": "<string>"
},
"createdDate": "2023-11-07T05:31:56Z",
"adjustments": [
{
"chargeId": "<string>",
"id": "<string>",
"amount": 123,
"createdDate": "2023-11-07T05:31:56Z",
"providerId": "<string>",
"locationId": "<string>",
"reason": "<string>"
}
],
"payments": [
{
"id": "<string>",
"amount": 123,
"createdDate": "2023-11-07T05:31:56Z",
"paymentMedium": "<string>",
"refunds": [
{
"id": "<string>",
"amount": 123,
"createdDate": "2023-11-07T05:31:56Z",
"description": "<string>",
"creator": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>"
}
}
],
"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>",
"isDefault": false,
"isArchived": false
}
}
],
"plannedPayments": [
{
"id": "<string>",
"amount": 123,
"paymentDate": "2023-11-07T05:31:56Z"
}
],
"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>"
]
}
],
"description": "<string>",
"ruleSetId": "<string>",
"externalCreatedDate": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"creator": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>"
},
"comment": "<string>",
"locationId": "<string>",
"tips": []
}
],
"total": 123
}Billing
Get Charges Table
GET
/
billing
/
charge
/
table
Get Charges Table
curl --request GET \
--url https://api.decodahealth.com/billing/charge/table \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'{
"data": [
{
"id": "<string>",
"total": 123,
"totalOutstanding": 123,
"patient": {
"id": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>",
"externalId": "<string>",
"address": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"addressValid": true,
"meta": {},
"isArchived": true,
"primaryLocationId": "<string>",
"gender": "<string>",
"dateOfBirth": "2023-12-25",
"patientMedications": [
"<string>"
],
"onSchedulingBlacklist": true,
"surchargeDisabled": true,
"tags": [
{
"id": "<string>",
"name": "<string>",
"isActive": true,
"createdDate": "2023-11-07T05:31:56Z",
"emoji": "<string>",
"color": "<string>",
"updatedDate": "2023-11-07T05:31:56Z"
}
],
"creditBalance": 123,
"preferredProviderId": "<string>"
},
"createdDate": "2023-11-07T05:31:56Z",
"adjustments": [
{
"chargeId": "<string>",
"id": "<string>",
"amount": 123,
"createdDate": "2023-11-07T05:31:56Z",
"providerId": "<string>",
"locationId": "<string>",
"reason": "<string>"
}
],
"payments": [
{
"id": "<string>",
"amount": 123,
"createdDate": "2023-11-07T05:31:56Z",
"paymentMedium": "<string>",
"refunds": [
{
"id": "<string>",
"amount": 123,
"createdDate": "2023-11-07T05:31:56Z",
"description": "<string>",
"creator": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>"
}
}
],
"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>",
"isDefault": false,
"isArchived": false
}
}
],
"plannedPayments": [
{
"id": "<string>",
"amount": 123,
"paymentDate": "2023-11-07T05:31:56Z"
}
],
"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>"
]
}
],
"description": "<string>",
"ruleSetId": "<string>",
"externalCreatedDate": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"creator": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>"
},
"comment": "<string>",
"locationId": "<string>",
"tips": []
}
],
"total": 123
}Headers
The tenant you are making this request on behalf of
Your api key
Query Parameters
Available options:
OUTSTANDING, PAID, EXTERNAL_SETTLEMENT, VOID, WRITE_OFF, REFUNDED, CHARGEBACK, PAYMENT_PLAN, COLLECTIONS ⌘I
