--- title: "Get Charges Table" method: GET path: "/billing/charge/table" tags: ["provider", "billing"] --- # Get Charges Table `GET /billing/charge/table` ## Query parameters - `page` integer, nullable - `per_page` integer, nullable - `sort_by` string - `sort_direction` string - `location_id` string, nullable - `id` string, nullable - `patient_id` string, nullable - `name` string, nullable - `total` integer[], nullable - `total_outstanding` integer[], nullable - `description` string, nullable - `status` ChargeStatus[], nullable - `external_id` string, nullable - `created_date` union - string[] - string - `payment_date` union - string[] - string - `tz` string, nullable ## Headers - `TENANT` string, required - `API-KEY` string, required ## Response `200` Successful Response - PageChargeTable - `data` ChargeTableOutput[], required - `id` string, required - `total` integer, required - `totalOutstanding` integer, required - `description` string, nullable - `status` 'OUTSTANDING' | 'PAID' | 'EXTERNAL_SETTLEMENT' | 'VOID' | 'WRITE_OFF' | 'REFUNDED' | 'CHARGEBACK' | 'PAYMENT_PLAN' | 'COLLECTIONS', required - `patient` PatientSummary, required - `id` string, required — The unique identifier for the user. - `firstName` string, nullable — The user's first name. - `lastName` string, nullable — The user's last name. - `phoneNumber` string, nullable — The user's phone number. - `email` string, nullable — The user's email address. - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required - `locationId` string, nullable — The location of the user. - `externalId` string, nullable — The user's external identifier if available. - `address` string, nullable — The user's primary address. - `addressLineTwo` string, nullable — Additional address information. - `city` string, nullable — The city of the user's address. - `state` string, nullable — The state of the user's address. - `zipCode` string, nullable — The postal code of the user's address. - `country` string, nullable — The country of the user's address. - `createdDate` string, date-time, required — The date and time when the user was created. - `addressValid` boolean, nullable — Whether the user's address is valid. - `meta` object, nullable — Any additional metadata about the user relevant to your system. - `isArchived` boolean, nullable — Whether the user is archived. - `primaryLocationId` string, nullable — The primary location of the user. - `gender` string, nullable — The gender of the patient. - `dateOfBirth` string, date, nullable — The date of birth of the patient. - `patientMedications` string[], nullable — List of patient's self-reported medications. - `onSchedulingBlacklist` boolean, nullable — Whether the patient is on the scheduling blacklist. - `surchargeDisabled` boolean, nullable — Whether surcharges are disabled for this patient. - `tags` PatientTagSummary[], nullable — List of patient tags - `id` string, required — Unique identifier for the patient tag - `name` string, required — Name of the patient tag - `emoji` string, nullable — Emoji associated with the tag - `color` string, nullable — Color code for the tag (hex format) - `isActive` boolean, required — Whether the tag is active - `createdDate` string, date-time, required — Date and time when the tag was created - `updatedDate` string, date-time, nullable — Date and time when the tag was last updated - `creditBalance` integer, nullable — Patient's credit balance in cents. - `preferredProviderId` string, nullable — The preferred provider ID for this patient. - `ruleSetId` string, nullable - `externalCreatedDate` string, date-time, nullable - `createdDate` string, date-time, required - `externalId` string, nullable - `creator` UserTiny - `id` string, required — The unique identifier for the user. - `firstName` string, nullable — The user's first name. - `lastName` string, nullable — The user's last name. - `phoneNumber` string, nullable — The user's phone number. - `email` string, nullable — The user's email address. - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required - `locationId` string, nullable — The location of the user. - `adjustments` AdjustmentSummary[], required - `chargeId` string, required - `providerId` string, nullable - `locationId` string, nullable - `id` string, required — Unique identifier for the adjustment - `amount` integer, required — Amount of the adjustment - `reason` string, nullable — Reason for the adjustment - `createdDate` string, date-time, required — Date when the adjustment was created - `adjustmentType` 'WRITE_OFF' | 'ADJUSTMENT' | 'EXTERNAL_SETTLEMENT', required - `payments` ChargeTablePaymentOutput[], required - `id` string, required - `amount` integer, required - `status` 'CANCELED' | 'CREATED' | 'FAILED' | 'IN_REVIEW' | 'PRESENTING' | 'PROCESSING' | 'SUCCEEDED', required - `createdDate` string, date-time, required - `paymentMedium` string, required - `paymentMethod` PaymentMethodSummary - `id` string, required - `patientId` string, nullable, required - `rainforestPaymentMethodId` string, required - `brand` string, nullable, required - `last4` string, nullable, required - `expMonth` integer, nullable, required - `expYear` integer, nullable, required - `accountHolderType` string, nullable, required - `accountNumberLast4` integer, nullable, required - `bankName` string, nullable, required - `routingNumber` integer, nullable, required - `description` string, nullable, required - `type` 'CARD' | 'ACH' | 'APPLE_PAY', required - `isDefault` boolean - `isArchived` boolean - `refunds` TableRefundOutput[], required - `id` string, required - `amount` integer, required - `reason` 'DUPLICATE' | 'DISPUTE' | 'BOOKING_FEE' | 'OTHER', required - `createdDate` string, date-time, required - `description` string, nullable - `creator` UserTiny - `id` string, required — The unique identifier for the user. - `firstName` string, nullable — The user's first name. - `lastName` string, nullable — The user's last name. - `phoneNumber` string, nullable — The user's phone number. - `email` string, nullable — The user's email address. - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required - `locationId` string, nullable — The location of the user. - `plannedPayments` ChargeTablePlannedPayment[], required - `id` string, required - `amount` integer, required - `status` 'SCHEDULED' | 'COMPLETED' | 'FAILED' | 'CANCELLED', required - `paymentDate` string, date-time, required - `comment` string, nullable - `items` ChargeItem[], required - `id` string, nullable — Unique identifier for the charge item - `itemId` string, nullable — Optional unique identifier for the item - `chargeId` string, required — Identifier of the charge this item is associated with - `name` string, nullable — Name of the item (None for items with associated inventory item) - `description` string, nullable — Description of the item - `quantity` integer, required — Quantity of the item being charged - `discountAmount` integer, nullable — Discount amount for the item - `discountPercentage` number, nullable — Discount percentage for the item - `discountReason` string, nullable — Reason for discount - `price` integer, required — Price of the item in cents - `soldPackageId` string, nullable — Unique identifier for the sold package usage - `bankedQuantity` integer, nullable — Quantity to bank for later use - `bankedItemId` string, nullable — ID of banked item being used (for tracking usage) - `issuedDiscountId` string, nullable — Unique identifier for the specific issued discount instance used - `soldByProviderId` string, nullable — Unique identifier for the provider who sold the item - `taxAmount` integer, nullable — Tax amount for the item in cents - `pricingId` string, nullable — Unique identifier for the pricing for the item - `shipmentIds` string[], nullable — Optional list of shipment IDs to reduce the stock quantity of - `locationId` string, nullable - `tips` TipDetail[] — List of `Tips` in the `Charge`. - `chargeId` string, required — Charge ID this tip belongs to - `amount` integer, required — Tip amount in cents - `providerId` string, required — Provider ID receiving the tip - `id` string — Unique identifier for the tip - `provider` ProviderTiny - `id` string, required - `firstName` string, required - `lastName` string, nullable - `email` string, nullable - `createdDate` string, date-time, nullable - `total` integer, required ## Other responses - `422` — Validation Error --- [API](https://skmtc.dev/decodahealth/apis/decoda-api.md) · [All operations](https://skmtc.dev/decodahealth/apis/decoda-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/decodahealth/decoda-api/revisions/4939a65a89d2/schema)