--- title: "View payment" method: GET path: "/payments/{id}" tags: ["Payments"] --- # View payment `GET /payments/{id}` This endpoint returns a single ledger payment ## Path parameters - `id` integer, required ## Query parameters - `subdomain` string, required - `include[]` string[] ## Headers - `Nex-Api-Version` string, required ## Response `200` Successful - APIV20240412EntitiesLedgerPaymentWithIncludesResponse — API_V20240412_Entities_Ledger_PaymentWithIncludes_Response model - `code` boolean — Indicates the success or failure of the request - `description` string — Additional context on the request to help with debugging. - `error` string[] — Any errors that occur during the execution of the request. - `data` APIV20240412EntitiesLedgerPaymentWithIncludes - `id` integer — Resource id - `foreign_id` string — Unique identifier of this resource from the integrated system - `location_id` integer, nullable — The ID of the location that this item is for - `patient_id` integer, nullable — The ID of the patient that this item is for - `guarantor_id` integer, nullable — The ID of the guarantor that this item is for - `provider_id` integer, nullable — The ID of the provider that this item is for - `updated_at` string, date-time — Last updated time for item in UTC - `description` string, nullable — A description of the item - `deleted_at` string, date-time, nullable — Deleted time for item in UTC - `payment_amount` APIV2EntitiesPrice - `amount` string — The currency value, in whole units (e.g. dollars) - `currency` string — The ISO currency code - `paid_at` string, date, nullable — The UTC date payment was made - `transaction_id` string, nullable — The ID of the transaction for this payment - `charge_id` integer, nullable — The ID of the charge for this payment - `claim_id` integer, nullable — The ID of the insurance claim for this payment - `payment_plan_id` integer, nullable — The ID of the payment plan associated with this payment - `insurance_plan_id` integer, nullable — The ID of the insurance plan associated with this payment - `patient` APIV2EntitiesPatientBasic - `id` integer — User id - `email` string, nullable — User email - `first_name` string — First name - `middle_name` string, nullable — Middle name - `last_name` string — Last name - `name` string — Full name - `created_at` string, date-time — User creation date in UTC - `updated_at` string, date-time — User last updation date in UTC - `institution_id` integer — The institution this user belongs to - `foreign_id` string, nullable — Foreign Id is a unique identifier from the integrated system - `foreign_id_type` string — Foreign Id type is a unique string identifier for the integrated system - `bio` object — Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned - `inactive` boolean — Is the user inactivated? - `last_sync_time` string, date-time, nullable — The most recent time the resource's data changed meaningfully at the source - `guarantor_id` integer, nullable — User id of this patient's responsible party - `billing_type` string, nullable — Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type - `chart_id` string, nullable — User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users - `preferred_language` string, nullable — Patient's preferred language as an ISO 639-1 code, if specified in the integrated system - `preferred_locale` string, nullable — The patient's preferred language setting used for displaying NexHealth forms and communications - `location_ids` integer[] — Array of location ids associated with the user - `provider` APIV2EntitiesProvider - `id` integer — User id - `email` string, nullable — User email - `first_name` string — First name - `middle_name` string, nullable — Middle name - `last_name` string — Last name - `name` string — Full name - `created_at` string, date-time — User creation date in UTC - `updated_at` string, date-time — User last updation date in UTC - `institution_id` integer — The institution this user belongs to - `foreign_id` string, nullable — Foreign Id is a unique identifier from the integrated system - `foreign_id_type` string — Foreign Id type is a unique string identifier for the integrated system - `bio` object — Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned - `inactive` boolean — Is the user inactivated? - `last_sync_time` string, date-time, nullable — The most recent time the resource's data changed meaningfully at the source - `display_name` string — Display name - `npi` string — National Provider Identifier as registered in NPPES. May be null if the practice did not enter it into the integrated system. - `tin` string — Taxpayer Identification Number (SSN or ITIN). May be null if the practice did not enter it into the integrated system. - `state_license` string — State license number. May be null if the practice did not enter it into the integrated system. - `specialty_code` string — Specialty code corresponding to the provider's state license and NPI. May be null if the practice did not enter it into the integrated system. - `guarantor` APIV2EntitiesPatientBasic - `id` integer — User id - `email` string, nullable — User email - `first_name` string — First name - `middle_name` string, nullable — Middle name - `last_name` string — Last name - `name` string — Full name - `created_at` string, date-time — User creation date in UTC - `updated_at` string, date-time — User last updation date in UTC - `institution_id` integer — The institution this user belongs to - `foreign_id` string, nullable — Foreign Id is a unique identifier from the integrated system - `foreign_id_type` string — Foreign Id type is a unique string identifier for the integrated system - `bio` object — Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned - `inactive` boolean — Is the user inactivated? - `last_sync_time` string, date-time, nullable — The most recent time the resource's data changed meaningfully at the source - `guarantor_id` integer, nullable — User id of this patient's responsible party - `billing_type` string, nullable — Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type - `chart_id` string, nullable — User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users - `preferred_language` string, nullable — Patient's preferred language as an ISO 639-1 code, if specified in the integrated system - `preferred_locale` string, nullable — The patient's preferred language setting used for displaying NexHealth forms and communications - `location_ids` integer[] — Array of location ids associated with the user - `claim` APIV2EntitiesLedgerInsuranceClaimBasic - `id` integer — Insurance Claim id - `location_id` integer — Location id - `patient_id` integer — Patient id - `provider_id` integer — Provider id - `guarantor_id` integer — User id of the patient's responsible party - `subscription_id` integer — Id of the patient's insurance subscription - `status` 'draft' | 'sent' | 'received' | 'approved' | 'paid' | 'rejected' | 'canceled' — Insurance Claim status - `finalized_at` string, date-time — Time in UTC when claim was closed - `sent_at` string, date-time — Time in UTC when claim was sent - `note` string — Note associated with the claim - `payment_estimate_total` APIV2EntitiesPrice - `amount` string — The currency value, in whole units (e.g. dollars) - `currency` string — The ISO currency code - `write_off_estimate_total` APIV2EntitiesPrice - `amount` string — The currency value, in whole units (e.g. dollars) - `currency` string — The ISO currency code - `write_off_total` APIV2EntitiesPrice - `amount` string — The currency value, in whole units (e.g. dollars) - `currency` string — The ISO currency code - `deleted_at` string, date-time — Deleted time for item in UTC - `charge` APIV2EntitiesPatientLedgerCharge - `id` integer — Resource id - `foreign_id` string — Unique identifier of this resource from the integrated system - `location_id` integer, nullable — The ID of the location that this item is for - `patient_id` integer, nullable — The ID of the patient that this item is for - `guarantor_id` integer, nullable — The ID of the guarantor that this item is for - `provider_id` integer, nullable — The ID of the provider that this item is for - `updated_at` string, date-time — Last updated time for item in UTC - `description` string, nullable — A description of the item - `deleted_at` string, date-time, nullable — Deleted time for item in UTC - `fee` APIV2EntitiesPrice - `amount` string — The currency value, in whole units (e.g. dollars) - `currency` string — The ISO currency code - `charged_at` string, date — The UTC date charge was made - `procedure_id` string — The ID of the procedure associated with this charge - `claim_ids` integer[] — Insurance claim IDs associated with this charge - `payment_estimate_total` APIV2EntitiesPrice - `amount` string — The currency value, in whole units (e.g. dollars) - `currency` string — The ISO currency code - `write_off_estimate_total` APIV2EntitiesPrice - `amount` string — The currency value, in whole units (e.g. dollars) - `currency` string — The ISO currency code - `write_off_total` APIV2EntitiesPrice - `amount` string — The currency value, in whole units (e.g. dollars) - `currency` string — The ISO currency code - `payment_plan` APIV2EntitiesPaymentPlan - `id` integer — Resource id - `patient_id` integer — The ID of patient this plan is for - `guarantor_id` integer — The ID of the person paying for the plan - `first_payment_due_date` string, date — The date the first payment is due (this doesn’t include down payments) - `created_date` string, date — The date the payment plan was created - `active` boolean — Indicates whether the payment plan has been closed, cleared, or deleted from the system - `payment_type` APIV20240412EntitiesLedgerPaymentType - `id` integer — Resource id - `name` string — The name of the payment type - `active` boolean — Whether the payment type is currently active - `updated_at` string, date-time — Payment Type update date in UTC - `payment_type_id` integer, nullable — The ID of the payment type for this payment - `count` integer — Number of total objects, in case of collection. ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Forbidden - `500` — Internal Server Error --- [API](https://skmtc.net/nexhealth/apis/nexhealth-api.md) · [All operations](https://skmtc.net/nexhealth/apis/nexhealth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nexhealth/nexhealth-api/revisions/a180e830b672/schema)