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,
      "status": "OUTSTANDING",
      "patient": {
        "id": "<string>",
        "type": "PROVIDER",
        "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",
          "adjustmentType": "WRITE_OFF",
          "providerId": "<string>",
          "locationId": "<string>",
          "reason": "<string>"
        }
      ],
      "payments": [
        {
          "id": "<string>",
          "amount": 123,
          "status": "CANCELED",
          "createdDate": "2023-11-07T05:31:56Z",
          "paymentMedium": "<string>",
          "refunds": [
            {
              "id": "<string>",
              "amount": 123,
              "reason": "DUPLICATE",
              "createdDate": "2023-11-07T05:31:56Z",
              "description": "<string>",
              "creator": {
                "id": "<string>",
                "type": "PROVIDER",
                "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>",
            "type": "CARD",
            "isDefault": false,
            "isArchived": false
          }
        }
      ],
      "plannedPayments": [
        {
          "id": "<string>",
          "amount": 123,
          "status": "SCHEDULED",
          "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>",
        "type": "PROVIDER",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "locationId": "<string>"
      },
      "comment": "<string>",
      "locationId": "<string>",
      "tips": []
    }
  ],
  "total": 123
}

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,
      "status": "OUTSTANDING",
      "patient": {
        "id": "<string>",
        "type": "PROVIDER",
        "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",
          "adjustmentType": "WRITE_OFF",
          "providerId": "<string>",
          "locationId": "<string>",
          "reason": "<string>"
        }
      ],
      "payments": [
        {
          "id": "<string>",
          "amount": 123,
          "status": "CANCELED",
          "createdDate": "2023-11-07T05:31:56Z",
          "paymentMedium": "<string>",
          "refunds": [
            {
              "id": "<string>",
              "amount": 123,
              "reason": "DUPLICATE",
              "createdDate": "2023-11-07T05:31:56Z",
              "description": "<string>",
              "creator": {
                "id": "<string>",
                "type": "PROVIDER",
                "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>",
            "type": "CARD",
            "isDefault": false,
            "isArchived": false
          }
        }
      ],
      "plannedPayments": [
        {
          "id": "<string>",
          "amount": 123,
          "status": "SCHEDULED",
          "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>",
        "type": "PROVIDER",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "locationId": "<string>"
      },
      "comment": "<string>",
      "locationId": "<string>",
      "tips": []
    }
  ],
  "total": 123
}

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Query Parameters

page

integer | null

per_page

integer | null

sort_by

string

default:created_date

sort_direction

string

default:desc

location_id

string | null

patient_id

string | null

name

string | null

total

integer[] | null

total_outstanding

integer[] | null

description

string | null

status

enum<string>[] | null

Available options:

OUTSTANDING,

PAID,

EXTERNAL_SETTLEMENT,

VOID,

WRITE_OFF,

REFUNDED,

CHARGEBACK,

PAYMENT_PLAN,

COLLECTIONS

external_id

string | null

created_date

payment_date

string | null

Response

Successful Response

data

ChargeTable · object[]

required

Show child attributes

data.id

string

required

data.total

integer

required

data.totalOutstanding

integer

required

data.status

enum<string>

required

Available options:

OUTSTANDING,

PAID,

EXTERNAL_SETTLEMENT,

VOID,

WRITE_OFF,

REFUNDED,

CHARGEBACK,

PAYMENT_PLAN,

COLLECTIONS

data.patient

PatientSummary · object

required

Show child attributes

data.patient.id

string

required

The unique identifier for the user.

data.patient.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

data.patient.createdDate

string<date-time>

required

The date and time when the user was created.

data.patient.firstName

string | null

The user's first name.

data.patient.lastName

string | null

The user's last name.

data.patient.phoneNumber

string | null

The user's phone number.

data.patient.email

string | null

The user's email address.

data.patient.locationId

string | null

The location of the user.

data.patient.externalId

string | null

The user's external identifier if available.

data.patient.address

string | null

The user's primary address.

data.patient.addressLineTwo

string | null

Additional address information.

data.patient.city

string | null

The city of the user's address.

data.patient.state

string | null

The state of the user's address.

data.patient.zipCode

string | null

The postal code of the user's address.

data.patient.country

string | null

The country of the user's address.

data.patient.addressValid

boolean | null

Whether the user's address is valid.

data.patient.meta

Meta · object

Any additional metadata about the user relevant to your system.

data.patient.isArchived

boolean | null

Whether the user is archived.

data.patient.primaryLocationId

string | null

The primary location of the user.

data.patient.gender

string | null

The gender of the patient.

data.patient.dateOfBirth

string<date> | null

The date of birth of the patient.

data.patient.patientMedications

string[] | null

List of patient's self-reported medications.

data.patient.onSchedulingBlacklist

boolean | null

Whether the patient is on the scheduling blacklist.

data.patient.surchargeDisabled

boolean | null

Whether surcharges are disabled for this patient.

data.patient.tags

PatientTagSummary · object[] | null

List of patient tags

Show child attributes

data.patient.tags.id

string

required

Unique identifier for the patient tag

data.patient.tags.name

string

required

Name of the patient tag

data.patient.tags.isActive

boolean

required

Whether the tag is active

data.patient.tags.createdDate

string<date-time>

required

Date and time when the tag was created

data.patient.tags.emoji

string | null

Emoji associated with the tag

data.patient.tags.color

string | null

Color code for the tag (hex format)

data.patient.tags.updatedDate

string<date-time> | null

Date and time when the tag was last updated

data.patient.creditBalance

integer | null

Patient's credit balance in cents.

data.patient.preferredProviderId

string | null

The preferred provider ID for this patient.

data.createdDate

string<date-time>

required

data.adjustments

AdjustmentSummary · object[]

required

Show child attributes

data.adjustments.chargeId

string

required

data.adjustments.id

string

required

Unique identifier for the adjustment

data.adjustments.amount

integer

required

Amount of the adjustment

data.adjustments.createdDate

string<date-time>

required

Date when the adjustment was created

data.adjustments.adjustmentType

enum<string>

required

Type of the adjustment

Available options:

WRITE_OFF,

ADJUSTMENT,

EXTERNAL_SETTLEMENT

data.adjustments.providerId

string | null

data.adjustments.locationId

string | null

data.adjustments.reason

string | null

Reason for the adjustment

data.payments

ChargeTablePayment · object[]

required

Show child attributes

data.payments.id

string

required

data.payments.amount

integer

required

data.payments.status

enum<string>

required

Available options:

CANCELED,

CREATED,

FAILED,

IN_REVIEW,

PRESENTING,

PROCESSING,

SUCCEEDED

data.payments.createdDate

string<date-time>

required

data.payments.paymentMedium

string

required

data.payments.refunds

TableRefund · object[]

required

Show child attributes

data.payments.refunds.id

string

required

data.payments.refunds.amount

integer

required

data.payments.refunds.reason

enum<string>

required

Available options:

DUPLICATE,

DISPUTE,

BOOKING_FEE,

OTHER

data.payments.refunds.createdDate

string<date-time>

required

data.payments.refunds.description

string | null

data.payments.refunds.creator

UserTiny · object

Show child attributes

data.payments.refunds.creator.id

string

required

The unique identifier for the user.

data.payments.refunds.creator.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

data.payments.refunds.creator.firstName

string | null

The user's first name.

data.payments.refunds.creator.lastName

string | null

The user's last name.

data.payments.refunds.creator.phoneNumber

string | null

The user's phone number.

data.payments.refunds.creator.email

string | null

The user's email address.

data.payments.refunds.creator.locationId

string | null

The location of the user.

data.payments.paymentMethod

PaymentMethodSummary · object

Show child attributes

data.payments.paymentMethod.id

string

required

data.payments.paymentMethod.patientId

string | null

required

data.payments.paymentMethod.rainforestPaymentMethodId

string

required

data.payments.paymentMethod.brand

string | null

required

data.payments.paymentMethod.last4

string | null

required

data.payments.paymentMethod.expMonth

integer | null

required

data.payments.paymentMethod.expYear

integer | null

required

data.payments.paymentMethod.accountHolderType

string | null

required

data.payments.paymentMethod.accountNumberLast4

integer | null

required

data.payments.paymentMethod.bankName

string | null

required

data.payments.paymentMethod.routingNumber

integer | null

required

data.payments.paymentMethod.description

string | null

required

data.payments.paymentMethod.type

enum<string> | null

required

Available options:

CARD,

ACH,

APPLE_PAY

data.payments.paymentMethod.isDefault

boolean

default:false

data.payments.paymentMethod.isArchived

boolean

default:false

data.plannedPayments

ChargeTablePlannedPayment · object[]

required

Show child attributes

data.plannedPayments.id

string

required

data.plannedPayments.amount

integer

required

data.plannedPayments.status

enum<string>

required

Available options:

SCHEDULED,

COMPLETED,

FAILED,

CANCELLED

data.plannedPayments.paymentDate

string<date-time>

required

data.items

ChargeItem · object[]

required

Show child attributes

data.items.chargeId

string

required

Identifier of the charge this item is associated with

data.items.quantity

integer

required

Quantity of the item being charged

data.items.price

integer

required

Price of the item in cents

data.items.id

string | null

Unique identifier for the charge item

data.items.itemId

string | null

Optional unique identifier for the item

data.items.name

string | null

Name of the item (None for items with associated inventory item)

data.items.description

string | null

Description of the item

data.items.discountAmount

integer | null

Discount amount for the item

data.items.discountPercentage

number | null

Discount percentage for the item

data.items.discountReason

string | null

Reason for discount

data.items.soldPackageId

string | null

Unique identifier for the sold package usage

data.items.bankedQuantity

integer | null

Quantity to bank for later use

data.items.bankedItemId

string | null

ID of banked item being used (for tracking usage)

data.items.issuedDiscountId

string | null

Unique identifier for the specific issued discount instance used

data.items.soldByProviderId

string | null

Unique identifier for the provider who sold the item

data.items.taxAmount

integer | null

Tax amount for the item in cents

data.items.pricingId

string | null

Unique identifier for the pricing for the item

data.items.shipmentIds

string[] | null

Optional list of shipment IDs to reduce the stock quantity of

data.description

string | null

data.ruleSetId

string | null

data.externalCreatedDate

string<date-time> | null

data.externalId

string | null

data.creator

UserTiny · object

Show child attributes

data.creator.id

string

required

The unique identifier for the user.

data.creator.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

data.creator.firstName

string | null

The user's first name.

data.creator.lastName

string | null

The user's last name.

data.creator.phoneNumber

string | null

The user's phone number.

data.creator.email

string | null

The user's email address.

data.creator.locationId

string | null

The location of the user.

data.comment

string | null

data.locationId

string | null

data.tips

TipDetail · object[]

List of Tips in the Charge.

Show child attributes

data.tips.chargeId

string

required

Charge ID this tip belongs to

data.tips.amount

integer

required

Tip amount in cents

data.tips.providerId

string

required

Provider ID receiving the tip

data.tips.id

string

Unique identifier for the tip

data.tips.provider

ProviderTiny · object

Provider receiving the tip

Show child attributes

data.tips.provider.id

string

required

data.tips.provider.firstName

string

required

data.tips.provider.lastName

string | null

data.tips.provider.email

string | null

data.tips.provider.createdDate

string<date-time> | null

total

integer

required

Get Charges Get Daily Cash Transactions

⌘I

Getting Started

API

Tenant

Webhook

Get Charges Table

Headers

Query Parameters

Response