--- title: "List Deposits" method: GET path: "/billing/deposits" tags: ["provider", "billing"] --- # List Deposits `GET /billing/deposits` List deposits for a specific month. Month filter is required. ## Query parameters - `page` integer, nullable - `per_page` integer, nullable - `sort_by` string, nullable - `sort_direction` 'asc' | 'desc', nullable - `location_id` string, nullable - `merchant_account_id` string, nullable - `status` 'PROCESSING' | 'IN_REVIEW' | 'SUCCEEDED' | 'FAILED' - `rainforest_deposit_id` string, nullable - `month` string, nullable - `tz` string, nullable ## Headers - `TENANT` string, required - `API-KEY` string, required ## Request body - union - string[] - string ## Response `200` Successful Response - PageDepositDetails - `data` DepositDetails[], required - `rainforestDepositId` string, required — Unique identifier from Rainforest - `merchantAccountId` string, required — Associated merchant account ID - `amount` integer, required — Deposit amount in cents - `currency` string — Currency code - `fee` integer — Processing fee in cents - `netAmount` integer, required — Net amount after fees in cents - `status` 'PROCESSING' | 'IN_REVIEW' | 'SUCCEEDED' | 'FAILED' - `rainforestCreatedDate` string, date-time, nullable — Creation date from Rainforest - `rainforestUpdatedDate` string, date-time, nullable — Last update date from Rainforest - `description` string, nullable — Deposit description - `externalReference` string, nullable — External reference identifier - `id` string, required - `createdDate` string, date-time, required - `updatedDate` string, date-time, nullable - `subtotal` integer, nullable — Subtotal (sum of payments - sum of refunds) in cents - `totalFees` integer, nullable — Total fees (payment fees + refund fees + deposit fee) in cents - `amountDeposited` integer, nullable — Amount deposited (net amount) in cents - `payments` PaymentWithPatient[] — Payments in this deposit - `id` string, required — The unique identifier for the payment. - `patientId` string, nullable — The ID of the patient associated with the payment. - `payinId` string, nullable — The ID of the payin associated with the payment. - `amount` integer, required — The total amount of the payment. - `status` 'CANCELED' | 'CREATED' | 'FAILED' | 'IN_REVIEW' | 'PRESENTING' | 'PROCESSING' | 'SUCCEEDED', required - `currency` string — The currency in which the payment was made. - `payinConfigId` string, nullable — The configuration ID for the payin. - `paymentMedium` string, required — The name of the payment medium. - `paymentMethodId` string, nullable — The ID of the payment method used. - `stripePaymentIntentId` string, nullable — Stripe's payment intent ID if used. - `failedReason` string, nullable — Reason for payment failure if applicable. - `updatedDate` string, date-time, nullable — The date and time the payment was last updated. - `createdDate` string, date-time, required — The date and time the payment was created. - `fee` integer — The fee charged by the payment processor. - `feeToPatient` integer, required — The fee charged to the patient for the transaction. - `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` RefundSummary[] — List of refunds associated with the payment. - `id` string, required - `paymentId` string, required - `amount` integer, required - `reason` 'DUPLICATE' | 'DISPUTE' | 'BOOKING_FEE' | 'OTHER', required - `createdDate` string, date-time, required - `status` 'CANCELED' | 'CREATED' | 'FAILED' | 'IN_REVIEW' | 'PRESENTING' | 'PROCESSING' | 'SUCCEEDED', required - `rainforestRefundId` string, nullable - `fee` integer - `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. - `refunds` RefundWithPatient[] — Refunds in this deposit - `id` string, required - `paymentId` string, required - `amount` integer, required - `reason` 'DUPLICATE' | 'DISPUTE' | 'BOOKING_FEE' | 'OTHER', required - `createdDate` string, date-time, required - `status` 'CANCELED' | 'CREATED' | 'FAILED' | 'IN_REVIEW' | 'PRESENTING' | 'PROCESSING' | 'SUCCEEDED', required - `rainforestRefundId` string, nullable - `fee` integer - `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. - `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)