JOjoincandidhealth
v1

Get Multi

Changed on

Returns all Invoices for the authenticated user's organization with all filters applied.

get/api/import-invoice/v1

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/import-invoice/v1
  • Auth
    HTTP bearer

Query parameters

patient_external_idstring
encounter_external_idstring
notestring

partial match supported

due_date_beforestring date

all invoices whose due date is before this due date, not inclusive

due_date_afterstring date

all invoices whose due date is after this due date, not inclusive

status'DRAFT' | 'OPEN' | 'PAID' | 'VOID' | 'UNCOLLECTIBLE' | 'HELD'

all invoices that match any of the provided statuses

limitinteger

Defaults to 100

sort'CREATED_AT' | 'UPDATED_AT' | 'PATIENT_EXTERNAL_ID' | 'NOTE' | 'DUE_DATE' | 'STATUS'

Defaults to created_at

sort_direction'asc' | 'desc'

Sort direction. Defaults to descending order

page_tokenstring

Response

Response with status 200

prev_page_tokenstring
next_page_tokenstring

Changes

  • 24b2d80d577aRevision changes
    • breaking

      the query request parameter sort was restricted to a list of enum values

    • breaking

      the query request parameter status was restricted to a list of enum values

    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the new enum value CREATED_AT to the query request parameter sort

    • info

      added the new enum value DRAFT to the query request parameter status

    • info

      added the new enum value DUE_DATE to the query request parameter sort

    • info

      added the new enum value HELD to the query request parameter status

    • info

      added the new enum value NOTE to the query request parameter sort

    • info

      added the new enum value OPEN to the query request parameter status

    • info

      added the new enum value PAID to the query request parameter status

    • info

      added the new enum value PATIENT_EXTERNAL_ID to the query request parameter sort

    • info

      added the new enum value STATUS to the query request parameter sort

    • info

      added the new enum value UNCOLLECTIBLE to the query request parameter status

    • info

      added the new enum value UPDATED_AT to the query request parameter sort

    • info

      added the new enum value VOID to the query request parameter status

    • info

      for the query request parameter sort, the type was generalized from no type to string

    • info

      for the query request parameter status, the type was generalized from no type to string

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • 3a81ee81d4edRevision changes
    • info

      api operation id get_multi removed and replaced with v1_get_multi_3