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 PUT \
--url https://api.decodahealth.com/billing/rule-set/edit/{rule_set_id} \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"name": "<string>",
"description": "<string>",
"rules": []
}
'{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"rules": []
}Rule Set Edit
Edit an existing RuleSet and its associated Rules.
curl --request PUT \
--url https://api.decodahealth.com/billing/rule-set/edit/{rule_set_id} \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"name": "<string>",
"description": "<string>",
"rules": []
}
'{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"rules": []
}Headers
The tenant you are making this request on behalf of
Your api key
Path Parameters
Body
Name of the rule set to be updated.
Optional description of the rule set.
List of rules to update or create.
Show child attributes
Show child attributes
Name of the rule.
Identifier of the rule set this rule belongs to.
Optional ID of the rule. If present, the rule will be updated.
Number of days to delay before applying the rule.
Upper bound for the amount, exclusive.
Lower bound for the amount, exclusive.
Upper bound for the amount, inclusive.
Communication methods to be used for this rule.
The method used to send an invoice to a patient.
CHARGE_CARD, SMS, EMAIL, CALL, MAIL, EXPIRY Message to be sent when applying this rule, must contain the {url} and {first_name} placeholders.
Response
Successful Response
Unique identifier for the rule set.
Name of the rule set.
Optional description of the rule set.
List of rules contained in this rule set.
Show child attributes
Show child attributes
Unique identifier for the rule.
Name of the rule.
Number of days to delay before applying the rule.
Identifier of the rule set this rule belongs to.
Communication methods to be used for this rule.
The method used to send an invoice to a patient.
CHARGE_CARD, SMS, EMAIL, CALL, MAIL, EXPIRY Upper bound for the amount, exclusive.
Lower bound for the amount, exclusive.
Upper bound for the amount, inclusive.
Message to be sent when applying this rule.