Skip to navigation

export_payment_details

All data associated with a payment. Can be joined to the Transaction table by transaction_id.

Primary Key: transaction_id

Identifiers

transaction_id
STRINGRequired

Unique Transaction ID

charge_id
STRING

Parent charge for the transaction, so it allows you to tie payments and adjustments to the original charge (billed A/R)

payer_plan_group_id
STRING

Unique ID associated with the specific Payer Plan

Timestamps

updated_at
TIMESTAMP

Time when the payment transaction was last updated.

Organization

organization_id
STRING

User’s unique organization ID in the Candid system

organization_name
STRING

User’s Organization / Company Name

external_organization_id
STRING

Organization’s External ID - the ID that the organization uses to map to their own upstream system

Payment Details

payment_type
STRING

Type of Payment (ERA, Patient Payment, Non-Insurance Payment)

Derived Details

external_payment_id
STRING

External Payment ID / Check Number

check_date
DATE

Check Date

payment_posted_date
TIMESTAMP

Date of when Payment was posted in Candid

deposit_date
DATE

Date the associated payment was deposited

era_payment_id
STRING

ID of the originating remit (ERA) this payment was posted from. It never changes. Matches remit_id in the Candid API. To group by check or EFT, use consolidated_remit_id. Empty when the payment is not linked to a remit, such as patient and non-insurance payments.

consolidated_remit_id
STRING

ID of the primary remit this payment belongs to: one real-world check or EFT, which can group several originating remits (era_payment_id). This is the remit you balance against in Candid. It can change when Candid merges or splits remits, so group by it at query time rather than storing it as a permanent key. Empty when the payment is not linked to a remit, such as patient and non-insurance payments.

manual_remit_note
STRING

Note entered when the remit this payment came from was manually posted in Candid. Empty for payer-sent ERAs and non-insurance transactions.

era_payer_name
STRING

Payer of the 835 file / organization that issued the remit

era_payer_identifier
STRING

The 2U segment code that is used to help specifically identify the insurance company that is underwriting what the payment is

claim_status_code
INTEGER

X12 claim status code from the ERA (835) indicating the overall adjudication status of the claim (e.g., processed as primary, denied)

payer_claim_control_number
STRING

The payer’s internal reference number for the claim, as reported in the ERA

era_posted_by
STRING

ID of the user who posted the ERA

era_posted_by_name
STRING

Name of the user who posted the ERA

provider_adjustment_reason_code
STRING

X12 provider-level adjustment reason code (from the ERA 835 PLB segment) for the provider-level balance adjustment this payment settles.

plb_related_claim_ids
JSON

Claim IDs to which the provider-level balance (PLB) clearing-account allocation relates. Delivered as ARRAY<STRING> in BigQuery-direct datasets.

first_payment_posted_date
TIMESTAMP

Stable date the payment was first posted to the ledger. Unlike payment_posted_date, this does not change if the payment is later reallocated to a different charge — use it for period-over-period accounting and denial analysis.

first_charge_id
STRING

ID of the first charge on the service line this payment was posted against. Stable across charge rebills and reallocation.

first_payer_plan_group_id
STRING

Payer plan group of the first charge on the service line this payment was posted against.

monetary_transaction_id
STRING

ID of the patient transaction (payment, refund, or other). Can be joined to the Patient Monetary Transaction table. Each monetary_transaction_id has a 1:many relationship with transaction_id, since a patient transaction can be allocated and reallocated across claims and service lines over its lifetime. A monetary_transaction_id can appear on multiple rows in this table. Null for insurance and non-insurance payments.

action_type
STRING

posted, reallocated, or voided. Null for insurance and non-insurance payments.

actioned_by
STRING

ID of the user who performed the action

actioned_by_name
STRING

Name of the user who performed the action

Sync columns

_cds_row_version
TIMESTAMP

Time when this row’s delivered data last changed. Use this for incremental ingestion.

_cds_row_fingerprint
STRING

Hash of this row’s delivered data. Changes whenever any value in the row changes.