Skip to main content
GET
/
billing
/
rule
/
list
Get
curl --request GET \
  --url https://api.decodahealth.com/billing/rule/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "delayInDays": 123,
    "ruleSetId": "<string>",
    "methods": [
      "CHARGE_CARD"
    ],
    "amountLessThan": 123,
    "amountGreaterThan": 123,
    "lessThanOrEqualTo": 123,
    "message": "<string>"
  }
]

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Response

200 - application/json

Successful Response

​
id
string
required

Unique identifier for the rule.

​
name
string
required

Name of the rule.

​
delayInDays
integer
required

Number of days to delay before applying the rule.

​
ruleSetId
string
required

Identifier of the rule set this rule belongs to.

​
methods
enum<string>[]
required

Communication methods to be used for this rule.

The method used to send an invoice to a patient.

Available options:
CHARGE_CARD,
SMS,
EMAIL,
CALL,
MAIL,
EXPIRY
​
amountLessThan
integer | null

Upper bound for the amount, exclusive.

​
amountGreaterThan
integer | null

Lower bound for the amount, exclusive.

​
lessThanOrEqualTo
integer | null

Upper bound for the amount, inclusive.

​
message
string | null

Message to be sent when applying this rule.