Skip to main content
GET
/
billing
/
invoice
/
table
Get Invoices
curl --request GET \
  --url https://api.decodahealth.com/billing/invoice/table \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "data": [
    {
      "id": "<string>",
      "status": "ACTIVE",
      "createdDate": "2023-11-07T05:31:56Z",
      "invoices": [
        {
          "id": "<string>",
          "status": "PENDING",
          "amount": 123,
          "methodsAttempted": [
            "<array>"
          ],
          "method": "CHARGE_CARD",
          "rule": {
            "id": "<string>",
            "name": "<string>",
            "methods": [
              "CHARGE_CARD"
            ],
            "delayInDays": 123,
            "message": "<string>"
          },
          "sendTime": "2023-11-07T05:31:56Z",
          "pausedDate": "2023-11-07T05:31:56Z",
          "resumedDate": "2023-11-07T05:31:56Z",
          "failedReason": "<string>",
          "pdfPath": "<string>",
          "emailStatus": "<string>",
          "smsContent": "<string>",
          "callStatus": "<string>"
        }
      ],
      "patient": {
        "id": "<string>",
        "firstName": "<string>",
        "charges": [
          {
            "id": "<string>",
            "createdDate": "2023-11-07T05:31:56Z",
            "totalOutstanding": 123,
            "total": 123,
            "externalCreatedDate": "2023-11-07T05:31:56Z"
          }
        ],
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "address": "<string>",
        "addressLineTwo": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipCode": "<string>",
        "country": "<string>"
      },
      "resumedDate": "2023-11-07T05:31:56Z",
      "pausedDate": "2023-11-07T05:31:56Z",
      "updatedDate": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Query Parameters

​
page
integer | null
​
per_page
integer | null
​
sort_by
string | null
default:send_time
​
sort_direction
enum<string> | null
default:desc
Available options:
asc,
desc
​
location_id
string | null
​
search_term
string | null
​
rule_set_id
string | null
​
status
enum<string>[] | null

The status of an invoice set.

Available options:
ACTIVE,
PAUSED,
CANCELLED,
EXPIRED,
PAID,
WILL_FAIL,
FAILED
​
amount
integer[] | null
​
created_date
string<date-time>[] | null
​
send_time
string<date-time>[] | null
​
tz
string | null

Response

Successful Response

​
data
InvoiceSetForTable · object[]
required
​
total
integer
required