GET api/v1/{EMRSystem}/BillingAccounts

Returns the Billing Accounts for a given patient.

Status: Released

URI Parameters

Name	Description	Type	Additional information
EMRSystem	The emr system.	EMRSystem	None.
UserId	Gets or sets the user identifier.	string	Required
PatientId	Gets or sets the patient identifier.	string	Required
EncounterId	Gets or Sets the encounter identifier	string	None.
UserType	Gets or sets the type of the user.	UserType	None.

Header Parameters

Name	Description	Type	Additional information
LoginId	Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers.	string	Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
Password	Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers.	string	Data type: Password Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
EmrInstance	Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers.	string	None.
ApplicationName	Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers.	string	Required if using application keys
ApplicationKey	Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers.	string	Data type: Password Required if using application keys
AuthorizationToken	Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers.	string	None.
RequestVerboseLogging	Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers.	boolean	None.

Response Information

Collection of UdmBillingAccountResponse

Name	Description	Type	Additional information
FinancialNumber	Gets or sets the Financial Number	string	None.
BillingStatus	Gets or sets the Billing Status	CodedObject	None.
AdmitDateTime	Gets or sets the Admit DateTime	datetime	None.
DischargeDateTime	Gets or sets the Discharge DateTime	datetime	None.
InpatientDateTime	Gets or sets the Inpatient DateTime	datetime	None.
BirthWeight	Gets or sets the Birth Weight	string	None.
BirthWeightUnits	Gets or sets the Birth Weight Units	CodedObject	None.
IsPsych	Gets or sets the Is Psych Flag	boolean	None.
PatientClass	Gets or sets the Patient Class	CodedObject	None.
AdmitSource	Gets or sets the Admit Source	CodedObject	None.
AdmitType	Gets or sets the Admit Type	CodedObject	None.
AdmitUnit	Gets or sets the Admit Unit	BaseDepartment	None.
DischargeUnit	Gets or sets the Discharge Unit	BaseDepartment	None.
DischargeDestination	Gets or sets the Discharge Destination	CodedObject	None.
AdmittingProvider	Gets or sets the Admitting Provider	ProviderWithNPI	None.
ReferringProvider	Gets or sets the Referring Provider	ProviderWithNPI	None.
AttendingProviders	Gets or sets the Attending Providers	Collection of ProviderWithNPI	None.
EmergencyRoomProviders	Gets or sets the Emergency Room Providers	Collection of ProviderWithNPI	None.
OtherProviders	Gets or sets the Other Providers	Collection of ProviderWithNPI	None.
TotalCharges	Gets or sets the Total Charges	string	None.
TotalCost	Gets or sets the Total Cost	string	None.
Procedures	Gets or sets the Procedures	Collection of BillingProcedure	None.
AdmitDiagnoses	Gets or sets the Admit Diagnoses	Collection of AdmitDiagnosis	None.
FinalDiagnoses	Gets or sets the Final Diagnoses	Collection of FinalDiagnosis	None.
DiagnosisRelatedGroups	Gets or sets the Diagnosis Realated Groups	Collection of BillingDiagnosisRelatedGroup	None.
CreatedUpdatedDateTime	Gets or sets the to created updated datetime.	datetime	None.
Patient	Gets or sets the patient.	BasePatient	None.
Encounter	Gets or sets the encounter.	Encounter	None.

Response Codes

Http Status Code 200 - Indicates that the request was processed successfully.

Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.

Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.

Http Status Code 403 - Indicates that there is an issue with the request UserId.

Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.

Http Status Code 500 - Indicates that an internal server error occurred during processing of the request.

Http Status Code 502 - Indicates that a request made to the underlying EMR server could not be completed.

Response Formats

application/json

[
  {
    "FinancialNumber": "sample string 1",
    "BillingStatus": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "AdmitDateTime": "2025-12-12T20:55:16.8931565+00:00",
    "DischargeDateTime": "2025-12-12T20:55:16.8932188+00:00",
    "InpatientDateTime": "2025-12-12T20:55:16.8932564+00:00",
    "BirthWeight": "sample string 2",
    "BirthWeightUnits": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "IsPsych": true,
    "PatientClass": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "AdmitSource": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "AdmitType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "AdmitUnit": {
      "DepartmentId": "sample string 1",
      "DepartmentName": "sample string 2"
    },
    "DischargeUnit": {
      "DepartmentId": "sample string 1",
      "DepartmentName": "sample string 2"
    },
    "DischargeDestination": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "AdmittingProvider": {
      "NPI": "sample string 1",
      "ProviderId": "sample string 2",
      "ProviderName": "sample string 3"
    },
    "ReferringProvider": {
      "NPI": "sample string 1",
      "ProviderId": "sample string 2",
      "ProviderName": "sample string 3"
    },
    "AttendingProviders": [
      {
        "NPI": "sample string 1",
        "ProviderId": "sample string 2",
        "ProviderName": "sample string 3"
      },
      {
        "NPI": "sample string 1",
        "ProviderId": "sample string 2",
        "ProviderName": "sample string 3"
      }
    ],
    "EmergencyRoomProviders": [
      {
        "NPI": "sample string 1",
        "ProviderId": "sample string 2",
        "ProviderName": "sample string 3"
      },
      {
        "NPI": "sample string 1",
        "ProviderId": "sample string 2",
        "ProviderName": "sample string 3"
      }
    ],
    "OtherProviders": [
      {
        "NPI": "sample string 1",
        "ProviderId": "sample string 2",
        "ProviderName": "sample string 3"
      },
      {
        "NPI": "sample string 1",
        "ProviderId": "sample string 2",
        "ProviderName": "sample string 3"
      }
    ],
    "TotalCharges": "sample string 3",
    "TotalCost": "sample string 4",
    "Procedures": [
      {
        "ProcedureName": "sample string 1",
        "CodeType": "sample string 2",
        "ProcedureCode": "sample string 3",
        "ProcedureDateTime": "2025-12-12T20:55:16.9081048+00:00",
        "Provider": {
          "NPI": "sample string 1",
          "ProviderId": "sample string 2",
          "ProviderName": "sample string 3"
        },
        "Modifiers": "sample string 4",
        "IsPrimary": true,
        "AnesthesiaType": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      },
      {
        "ProcedureName": "sample string 1",
        "CodeType": "sample string 2",
        "ProcedureCode": "sample string 3",
        "ProcedureDateTime": "2025-12-12T20:55:16.9081048+00:00",
        "Provider": {
          "NPI": "sample string 1",
          "ProviderId": "sample string 2",
          "ProviderName": "sample string 3"
        },
        "Modifiers": "sample string 4",
        "IsPrimary": true,
        "AnesthesiaType": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      }
    ],
    "AdmitDiagnoses": [
      {
        "DiagnosisName": "sample string 1",
        "CodeType": "sample string 2",
        "DiagnosisCode": "sample string 3",
        "IsPrimary": true
      },
      {
        "DiagnosisName": "sample string 1",
        "CodeType": "sample string 2",
        "DiagnosisCode": "sample string 3",
        "IsPrimary": true
      }
    ],
    "FinalDiagnoses": [
      {
        "DiagnosisName": "sample string 1",
        "CodeType": "sample string 2",
        "DiagnosisCode": "sample string 3",
        "IsPrimary": true,
        "PresentOnAdmission": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "IsHospitalAcquired": true
      },
      {
        "DiagnosisName": "sample string 1",
        "CodeType": "sample string 2",
        "DiagnosisCode": "sample string 3",
        "IsPrimary": true,
        "PresentOnAdmission": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "IsHospitalAcquired": true
      }
    ],
    "DiagnosisRelatedGroups": [
      null,
      {
        "DiagnosisRelatedGroupName": "sample string 1",
        "DiagnosisRelatedGroupCode": "sample string 2",
        "IsBilling": false
      }
    ],
    "CreatedUpdatedDateTime": "2025-12-12T20:55:16.9204704+00:00",
    "Patient": {
      "PatientId": "sample string 1",
      "DisplayName": "sample string 2",
      "LastName": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "MRN": "sample string 6",
      "BirthDateTime": "2025-12-12T20:55:16.9205549+00:00",
      "Gender": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "DeceasedDateTime": "2025-12-12T20:55:16.9205591+00:00"
    },
    "Encounter": {
      "EncounterId": "sample string 1",
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "PatientClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EncounterDateTime": "2025-12-12T20:55:16.9206125+00:00",
      "DischargeDateTime": "2025-12-12T20:55:16.9206146+00:00",
      "FinancialNumber": "sample string 2",
      "Location": {
        "BedId": "sample string 1",
        "Bed": "sample string 2",
        "RoomId": "sample string 3",
        "Room": "sample string 4",
        "UnitId": "sample string 5",
        "Unit": "sample string 6",
        "HospitalId": "sample string 7",
        "Hospital": "sample string 8"
      }
    }
  },
  {
    "FinancialNumber": "sample string 1",
    "BillingStatus": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "AdmitDateTime": "2025-12-12T20:55:16.8931565+00:00",
    "DischargeDateTime": "2025-12-12T20:55:16.8932188+00:00",
    "InpatientDateTime": "2025-12-12T20:55:16.8932564+00:00",
    "BirthWeight": "sample string 2",
    "BirthWeightUnits": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "IsPsych": true,
    "PatientClass": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "AdmitSource": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "AdmitType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "AdmitUnit": {
      "DepartmentId": "sample string 1",
      "DepartmentName": "sample string 2"
    },
    "DischargeUnit": {
      "DepartmentId": "sample string 1",
      "DepartmentName": "sample string 2"
    },
    "DischargeDestination": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "AdmittingProvider": {
      "NPI": "sample string 1",
      "ProviderId": "sample string 2",
      "ProviderName": "sample string 3"
    },
    "ReferringProvider": {
      "NPI": "sample string 1",
      "ProviderId": "sample string 2",
      "ProviderName": "sample string 3"
    },
    "AttendingProviders": [
      {
        "NPI": "sample string 1",
        "ProviderId": "sample string 2",
        "ProviderName": "sample string 3"
      },
      {
        "NPI": "sample string 1",
        "ProviderId": "sample string 2",
        "ProviderName": "sample string 3"
      }
    ],
    "EmergencyRoomProviders": [
      {
        "NPI": "sample string 1",
        "ProviderId": "sample string 2",
        "ProviderName": "sample string 3"
      },
      {
        "NPI": "sample string 1",
        "ProviderId": "sample string 2",
        "ProviderName": "sample string 3"
      }
    ],
    "OtherProviders": [
      {
        "NPI": "sample string 1",
        "ProviderId": "sample string 2",
        "ProviderName": "sample string 3"
      },
      {
        "NPI": "sample string 1",
        "ProviderId": "sample string 2",
        "ProviderName": "sample string 3"
      }
    ],
    "TotalCharges": "sample string 3",
    "TotalCost": "sample string 4",
    "Procedures": [
      {
        "ProcedureName": "sample string 1",
        "CodeType": "sample string 2",
        "ProcedureCode": "sample string 3",
        "ProcedureDateTime": "2025-12-12T20:55:16.9081048+00:00",
        "Provider": {
          "NPI": "sample string 1",
          "ProviderId": "sample string 2",
          "ProviderName": "sample string 3"
        },
        "Modifiers": "sample string 4",
        "IsPrimary": true,
        "AnesthesiaType": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      },
      {
        "ProcedureName": "sample string 1",
        "CodeType": "sample string 2",
        "ProcedureCode": "sample string 3",
        "ProcedureDateTime": "2025-12-12T20:55:16.9081048+00:00",
        "Provider": {
          "NPI": "sample string 1",
          "ProviderId": "sample string 2",
          "ProviderName": "sample string 3"
        },
        "Modifiers": "sample string 4",
        "IsPrimary": true,
        "AnesthesiaType": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      }
    ],
    "AdmitDiagnoses": [
      {
        "DiagnosisName": "sample string 1",
        "CodeType": "sample string 2",
        "DiagnosisCode": "sample string 3",
        "IsPrimary": true
      },
      {
        "DiagnosisName": "sample string 1",
        "CodeType": "sample string 2",
        "DiagnosisCode": "sample string 3",
        "IsPrimary": true
      }
    ],
    "FinalDiagnoses": [
      {
        "DiagnosisName": "sample string 1",
        "CodeType": "sample string 2",
        "DiagnosisCode": "sample string 3",
        "IsPrimary": true,
        "PresentOnAdmission": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "IsHospitalAcquired": true
      },
      {
        "DiagnosisName": "sample string 1",
        "CodeType": "sample string 2",
        "DiagnosisCode": "sample string 3",
        "IsPrimary": true,
        "PresentOnAdmission": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "IsHospitalAcquired": true
      }
    ],
    "DiagnosisRelatedGroups": [
      null,
      {
        "DiagnosisRelatedGroupName": "sample string 1",
        "DiagnosisRelatedGroupCode": "sample string 2",
        "IsBilling": false
      }
    ],
    "CreatedUpdatedDateTime": "2025-12-12T20:55:16.9204704+00:00",
    "Patient": {
      "PatientId": "sample string 1",
      "DisplayName": "sample string 2",
      "LastName": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "MRN": "sample string 6",
      "BirthDateTime": "2025-12-12T20:55:16.9205549+00:00",
      "Gender": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "DeceasedDateTime": "2025-12-12T20:55:16.9205591+00:00"
    },
    "Encounter": {
      "EncounterId": "sample string 1",
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "PatientClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EncounterDateTime": "2025-12-12T20:55:16.9206125+00:00",
      "DischargeDateTime": "2025-12-12T20:55:16.9206146+00:00",
      "FinancialNumber": "sample string 2",
      "Location": {
        "BedId": "sample string 1",
        "Bed": "sample string 2",
        "RoomId": "sample string 3",
        "Room": "sample string 4",
        "UnitId": "sample string 5",
        "Unit": "sample string 6",
        "HospitalId": "sample string 7",
        "Hospital": "sample string 8"
      }
    }
  }
]

GET api/v1/{EMRSystem}/BillingAccounts

Returns the Billing Accounts for a given patient.

Status: Released

URI Parameters

EMRSystem

Required

UserId

Required

PatientId

Required

EncounterId

UserType

Header Parameters

LoginId

Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox

Password

Data type: Password , Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox

EmrInstance

ApplicationName

Required if using application keys

ApplicationKey

Data type: Password , Required if using application keys

AuthorizationToken

RequestVerboseLogging

Request: {{ method }} {{ url }}

Http Request Headers
{{header.name}} : {{header.value}} ******

Http Request Body
```
{{httpRequestBody}}
```

Http Status Code: {{httpResponseStatus}}

Http Response Headers
{{header.name}} : {{header.value}} ******

Http Response Data
```
{{httpResponseData}}
```