Getting Started
API
- PUTAcknowledge Cash Balance Discrepancy
- POSTAdd Item To Cart
- POSTAdd Item To Quote
- DELCancel Payment Plan By Charge Id
- POSTCharge Payment Method
- POSTConvert Cart To Charge
- POSTConvert Quote To Charge
- POSTCreate Adjustment
- POSTCreate Cart
- POSTCreate Cash Balance
- POSTCreate Cash Balance Adjustment
- POSTCreate Cash Payment
- POSTCreate Cash Settled
- POSTCreate Charge
- POSTCreate Insurance Payment
- POSTCreate Manual Invoice
- POSTCreate Patient Credit Payment
- POSTCreate Patient Credit Settled
- POSTCreate Payin Config
- POSTCreate Payin Config Booking Fee
- POSTCreate Payin Config Booking Fee Billing
- POSTCreate Payment Method Config
- POSTCreate Payment Plan With Charges
- POSTCreate Quote
- POSTCreate Rainforest Payin Config
- POSTCreate Rule Set
- POSTCreate Tip
- POSTCreate Write Off
- DELDelete Cart
- DELDelete Charge Endpoint
- DELDelete Payment Endpoint
- DELDelete Rule
- DELDelete Rule Set
- DELDelete Tip
- PUTExecute Action
- POSTExpire Old Carts
- POSTExpire Old Quotes
- GETGet
- GETGet
- GETGet Available Months
- GETGet Cart By Id
- GETGet Carts
- GETGet Carts List
- GETGet Cash Balance Timeline
- GETGet Charge By Id
- GETGet Charge Timeline
- GETGet Charges
- GETGet Charges Table
- GETGet Daily Cash Transactions
- GETGet Daily External Settlements
- GETGet Detailed Tip Export Data
- GETGet Expected Cash Balance
- GETGet External Settlement Details
- GETGet Failed Payments
- GETGet Invoice Payment Link With Phone Number
- GETGet Invoices
- GETGet Invoicing Metrics
- GETGet Merchant Account
- GETGet Patients By Charge Ids
- GETGet Payment Items Authenticated
- GETGet Payment Link
- GETGet Payment Methods
- GETGet Payment Overview
- GETGet Payments Over Time
- GETGet Public Quote
- GETGet Quote By Id
- GETGet Quote View
- GETGet Quotes
- GETGet Receipt
- GETGet Receipt Items
- GETGet Revenue
- GETGet Tip
- GETGet Top Selling Items
- GETList Deposits
- GETList Devices
- GETList Merchant Accounts
- GETList Payments
- POSTMark No Charge
- POSTMove Payment
- POSTMove Payment To Location
- POSTRefund Payment
- DELRemove Cart Item
- DELRemove Quote Item
- POSTRespond To Quote
- PUTRetry Method
- PUTRetry Send
- PUTRule Set Edit
- GETSelect All
- PUTSend Now
- POSTSend Quote
- POSTSend Receipt
- POSTSend Receipt
- POSTSend To Patient
- POSTSend To Pos
- POSTSetup Invoicing
- POSTSetup Payin Component
- PUTUpdate Cart Full
- PUTUpdate Cart Item
- PUTUpdate Cash Balance
- PUTUpdate Cash Balance Adjustment
- POSTUpdate Charge Comment
- POSTUpdate Charge Details
- PUTUpdate Invoice
- PUTUpdate Merchant Account
- PATCHUpdate Payin Config Metadata
- PUTUpdate Quote
- PUTUpdate Quote Item
- POSTUpdate Sold By Provider
- PUTUpdate Tip
- POSTVerify Patient
- DELVoid Cash Balance
- DELVoid Cash Balance Adjustment
- PUT
Tenant
curl --request POST \
--url https://api.decodahealth.com/billing/payment-plan/create-with-charges \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"charges": [
{
"patientId": "<string>",
"totalOutstanding": 123,
"id": "<string>",
"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>"
},
"total": 0,
"description": "<string>",
"status": "OUTSTANDING",
"discountAmount": 0,
"discountPercentage": 0,
"externalId": "<string>",
"externalCreatedDate": "2023-11-07T05:31:56Z",
"ruleSetId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"creatorId": "<string>",
"items": [],
"tips": [],
"locationId": "<string>",
"eventId": "<string>",
"memberId": "<string>",
"comment": "<string>",
"meta": {},
"merchantAccountId": "<string>",
"payments": [],
"adjustments": []
}
],
"paymentPlan": {
"initialAmount": 123,
"chargeIds": [
"<string>"
],
"frequency": "WEEKLY",
"installments": 123,
"installmentAmount": 123,
"locationId": "<string>",
"startDate": "2023-12-25"
},
"rainforestPaymentMethodId": "<string>"
}
'{
"initialAmount": 123,
"chargeIds": [
"<string>"
],
"frequency": "WEEKLY",
"installments": 123,
"installmentAmount": 123,
"paymentMethodId": "<string>",
"locationId": "<string>",
"startDate": "2023-12-25",
"id": "<string>"
}Create Payment Plan With Charges
Create a payment plan with charges for $0 down payments.
- Creates charges using existing billing service
- Creates/stores payment method using existing billing service methods
- Creates payment plan with those charge IDs and payment method
curl --request POST \
--url https://api.decodahealth.com/billing/payment-plan/create-with-charges \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"charges": [
{
"patientId": "<string>",
"totalOutstanding": 123,
"id": "<string>",
"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>"
},
"total": 0,
"description": "<string>",
"status": "OUTSTANDING",
"discountAmount": 0,
"discountPercentage": 0,
"externalId": "<string>",
"externalCreatedDate": "2023-11-07T05:31:56Z",
"ruleSetId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"creatorId": "<string>",
"items": [],
"tips": [],
"locationId": "<string>",
"eventId": "<string>",
"memberId": "<string>",
"comment": "<string>",
"meta": {},
"merchantAccountId": "<string>",
"payments": [],
"adjustments": []
}
],
"paymentPlan": {
"initialAmount": 123,
"chargeIds": [
"<string>"
],
"frequency": "WEEKLY",
"installments": 123,
"installmentAmount": 123,
"locationId": "<string>",
"startDate": "2023-12-25"
},
"rainforestPaymentMethodId": "<string>"
}
'{
"initialAmount": 123,
"chargeIds": [
"<string>"
],
"frequency": "WEEKLY",
"installments": 123,
"installmentAmount": 123,
"paymentMethodId": "<string>",
"locationId": "<string>",
"startDate": "2023-12-25",
"id": "<string>"
}Headers
The tenant you are making this request on behalf of
Your api key
Body
Request schema for creating payment plans with charges ($0 down payments).
Show child attributes
Show child attributes
Identifier of the patient being charged.
Total outstanding amount that is yet to be paid.
A unique identifier for the charge. Auto-generated if not provided.
Summary details of the patient being charged.
Show child attributes
Show child attributes
The unique identifier for the user.
The type of user.
PROVIDER, PATIENT, ASSISTANT The date and time when the user was created.
The user's first name.
The user's last name.
The user's phone number.
The user's email address.
The location of the user.
The user's external identifier if available.
The user's primary address.
Additional address information.
The city of the user's address.
The state of the user's address.
The postal code of the user's address.
The country of the user's address.
Whether the user's address is valid.
Any additional metadata about the user relevant to your system.
Whether the user is archived.
The primary location of the user.
The gender of the patient.
The date of birth of the patient.
List of patient's self-reported medications.
Whether the patient is on the scheduling blacklist.
Whether surcharges are disabled for this patient.
List of patient tags
Show child attributes
Show child attributes
Unique identifier for the patient tag
Name of the patient tag
Whether the tag is active
Date and time when the tag was created
Emoji associated with the tag
Color code for the tag (hex format)
Date and time when the tag was last updated
Patient's credit balance in cents.
The preferred provider ID for this patient.
Total amount of the charge.
Description of the charge.
Current status of the charge.
OUTSTANDING, PAID, EXTERNAL_SETTLEMENT, VOID, WRITE_OFF, REFUNDED, CHARGEBACK, PAYMENT_PLAN, COLLECTIONS Any discount applied to the total outstanding.
Percentage of discount applied to the charge.
External identifier for the charge, if applicable.
The creation date of the charge in your external system, if applicable.
Identifier for the RuleSet applied to this Charge, if any.
The date when the charge was created.
Identifier of the Provider who created the charge (i.e. the Clinician, or relevant Biller).
List of Items in the Charge.
Show child attributes
Show child attributes
Identifier of the charge this item is associated with
Quantity of the item being charged
Price of the item in cents
Unique identifier for the charge item
Optional unique identifier for the item
Name of the item (None for items with associated inventory item)
Description of the item
Discount amount for the item
Discount percentage for the item
Reason for discount
Unique identifier for the sold package usage
Quantity to bank for later use
ID of banked item being used (for tracking usage)
Unique identifier for the specific issued discount instance used
Unique identifier for the provider who sold the item
Tax amount for the item in cents
Unique identifier for the pricing for the item
Optional list of shipment IDs to reduce the stock quantity of
List of Tips in the Charge.
Show child attributes
Show child attributes
Charge ID this tip belongs to
Tip amount in cents
Provider ID receiving the tip
Unique identifier for the tip
Identifier of the Location where the charge was created.
Identifier of the Event this charge is associated with, if any.
Identifier of the Member this charge is associated with, if any.
Any additional comments about the charge.
Any additional metadata about the charge relevant to your system.
Identifier of the MerchantAccount this charge is associated with.
List of Payments in the Charge.
Show child attributes
Show child attributes
The unique identifier for the payment.
The amount of the payment.
The unique identifier for the charge.
Detailed information about the payment.
Show child attributes
Show child attributes
The unique identifier for the payment.
The total amount of the payment.
The current status of the payment.
CANCELED, CREATED, FAILED, IN_REVIEW, PRESENTING, PROCESSING, SUCCEEDED The name of the payment medium.
The date and time the payment was created.
The fee charged to the patient for the transaction.
The ID of the patient associated with the payment.
The ID of the payin associated with the payment.
The currency in which the payment was made.
The configuration ID for the payin.
The ID of the payment method used.
Stripe's payment intent ID if used.
Reason for payment failure if applicable.
The date and time the payment was last updated.
The fee charged by the payment processor.
Summary of the payment method used.
Show child attributes
Show child attributes
CARD, ACH, APPLE_PAY List of refunds associated with the payment.
Show child attributes
Show child attributes
DUPLICATE, DISPUTE, BOOKING_FEE, OTHER CANCELED, CREATED, FAILED, IN_REVIEW, PRESENTING, PROCESSING, SUCCEEDED The date and time the payment was created.
List of Adjustments in the Charge.
Show child attributes
Show child attributes
Unique identifier for the adjustment
Amount of the adjustment
Date when the adjustment was created
Type of the adjustment
WRITE_OFF, ADJUSTMENT, EXTERNAL_SETTLEMENT Reason for the adjustment
Represents the creation of a payment plan without an ID.
This model defines the structure for creating a new payment plan, including details about the initial payment, associated charge, frequency of payments, number of installments, and the amount for each installment.
Show child attributes
Show child attributes
The initial payment amount for the payment plan
The IDs of the associated charges
The frequency of installment payments
WEEKLY, BIWEEKLY, MONTHLY The number of installment payments
The amount of each installment payment
The ID of the associated location
Optional start date for the first payment (only allowed for $0 down payment plans)
Response
Successful Response
Represents the creation of a payment plan with an ID and associated payment method.
This model extends PaymentPlanCreateWithoutID by adding an automatically generated ID and a required payment method ID. It includes all the fields from the parent class along with these additional attributes.
Attributes: id (str): An automatically generated unique identifier for the payment plan. payment_method_id (str): The ID of the associated payment method used for installments.
The initial payment amount for the payment plan
The IDs of the associated charges
The frequency of installment payments
WEEKLY, BIWEEKLY, MONTHLY The number of installment payments
The amount of each installment payment
The ID of the associated payment method
The ID of the associated location
Optional start date for the first payment (only allowed for $0 down payment plans)
The ID of the payment plan