GET
/
v1
/
charge
/
list
Charge List
curl --request GET \
  --url https://api.decodahealth.com/v1/charge/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "createdDate": "2023-11-07T05:31:56Z",
    "customAmount": 123,
    "description": "<string>",
    "discountAmount": 123,
    "discountPercentage": 123,
    "externalCreatedDate": "2023-11-07T05:31:56Z",
    "externalId": "<string>",
    "id": "<string>",
    "meta": {},
    "patient": {
      "address": "<string>",
      "addressLineTwo": "<string>",
      "addressValid": true,
      "allergies": [
        "<string>"
      ],
      "city": "<string>",
      "country": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "dateOfBirth": "2023-12-25",
      "email": "<string>",
      "externalUserId": "<string>",
      "familyHistory": [
        "<string>"
      ],
      "firstName": "<string>",
      "id": "<string>",
      "lastName": "<string>",
      "medicalHistory": [
        "<string>"
      ],
      "medications": [
        "<string>"
      ],
      "meta": {},
      "optedOutOfSms": false,
      "phoneNumber": "<string>",
      "prescriptions": [
        "<string>"
      ],
      "state": "<string>",
      "type": "<string>",
      "zipCode": "<string>"
    },
    "patientId": "<string>",
    "patientPaysProcessingFee": true,
    "ruleSetId": "<string>",
    "status": "OUTSTANDING",
    "total": 123,
    "totalOutstanding": 123
  }
]

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:
OUTSTANDING,
PAID,
EXTERNAL_SETTLEMENT,
VOID,
WRITE_OFF,
REFUNDED,
PAYMENT_PLAN
​
external_id
string

The external ID to filter by

​
total
number

The total to filter by

​
total_outstanding
number

The total outstanding to filter by

​
description
string

The description to filter by

​
n
integer
default:10

Response

200
application/json

Successful Response

The response is of type ChargeSummary · object[].