JOjoincandidhealth
v1

Get Transactions

Changed on

Paginated, combined list of InsurancePayment and InsuranceAdjustment transactions posted from a consolidated remit's ERA payments - covering service-payment-driven and payment-bundle-driven activity of both kinds, and both the posted and voided sides of each (see is_void). Each item is discriminated by type; fields common to both transaction types are always present alongside the type-specific ones. One combined, single-cursor pagination stream rather than two separate endpoints - filter to a single type with transaction_type if you only care about one.

get/api/external-consolidated-remit/v1/{consolidated_remit_id}/transactions

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/external-consolidated-remit/v1/{consolidated_remit_id}/transactions
  • Auth
    HTTP bearer

Path parameters

consolidated_remit_idstring uuid required

Query parameters

page_tokenstring
limitinteger

Defaults to 100.

era_payment_idstring uuid

Retrieve only transactions sourced from any of the given ERA payments (matches the transaction's remit_id).

transaction_idstring uuid

Retrieve only the given transaction(s), regardless of type.

transaction_type'insurance_payment' | 'insurance_adjustment'

Whether this transaction is an insurance payment or an insurance adjustment (write-off).

Retrieve only transactions of the given type(s). Defaults to both.

Response

Response with status 200

prev_page_tokenstring
next_page_tokenstring

Changes

  • d8b0a61873e2Revision changes
    • breaking

      added subschema #1 subschema #2 to the / response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the / response property oneOf list for the response status

  • 97de8fddb088Revision changes
    • info

      endpoint added