Skip to main content
GET
/
v1
/
invoice
/
list
List Invoices
curl --request GET \
  --url https://api.decodahealth.com/v1/invoice/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "actionId": "<string>",
    "active": true,
    "createdDate": "2023-11-07T05:31:56Z",
    "decodaPaymentLinkUrl": "<string>",
    "id": "<string>",
    "method": "Native",
    "patientId": "<string>",
    "paymentLinkUrl": "<string>",
    "ruleId": "<string>"
  }
]

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Query Parameters

​
sort_by
string
default:created_date

The field to sort by in snake case, i.e. created_date

​
sort_direction
enum<string>
default:desc

The direction to sort by

Available options:
asc,
desc
​
patient_id
string

The patient ID to filter by

​
status
enum<string>

The status to filter by

Available options:
active,
inactive
​
external_id
string

The external ID to filter by

Response

Successful Response

​
active
boolean
required

Indicates whether this invoice is currently active.

​
createdDate
string<date-time>
required

The date and time when this invoice was created.

​
decodaPaymentLinkUrl
string
required

Decoda-specific URL for payment processing.

​
id
string
required

Unique identifier for the invoice.

​
method
enum<string>
required

The method used to communicate this invoice to the patient.

Available options:
Native,
SMS,
MAIL,
CALL,
COLLECTIONS,
EMAIL,
SMS_AND_EMAIL
​
patientId
string
required

Identifier of the patient associated with this invoice.

​
paymentLinkUrl
string
required

URL for the patient to make a payment for this invoice.

​
actionId
string | null

Identifier of the action that created this invoice, if applicable.

​
ruleId
string | null

Identifier of the rule that triggered this invoice, if applicable.