IPrimeSuiteAPI REST API Documentation


FamilyBalanceGet


Method: POST

URI Template: https://api-test.greenwaymedical.com/Integration/RESTv1.0/PrimeSuiteAPIService/Patient/FamilyBalanceGet

Request Format: Xml or Json

Request XML Example (schema): 

<?xml version="1.0" encoding="utf-16"?>
<FamilyBalanceGetRequest>
  <Header>
    <SourceSiteID>String Content</SourceSiteID>
    <DestinationSiteID>String Content</DestinationSiteID>
    <PrimeSuiteUserID>0</PrimeSuiteUserID>
  </Header>
  <Credentials>
    <PrimeSuiteCredential>
      <PrimeSuiteSiteId>String Content</PrimeSuiteSiteId>
      <PrimeSuiteUserName>String Content</PrimeSuiteUserName>
      <PrimeSuiteUserPassword>String Content</PrimeSuiteUserPassword>
      <PrimeSuiteUserAlias>String Content</PrimeSuiteUserAlias>
    </PrimeSuiteCredential>
    <VendorCredential>
      <VendorLogin>String Content</VendorLogin>
      <VendorPassword>String Content</VendorPassword>
    </VendorCredential>
  </Credentials>
  <PatientID>0</PatientID>
</FamilyBalanceGetRequest>

Request Json Example (schema): 

{
  "Header": {
    "SourceSiteID": "String Content",
    "DestinationSiteID": "String Content",
    "PrimeSuiteUserID": 0
  },
  "Credentials": {
    "PrimeSuiteCredential": {
      "PrimeSuiteSiteId": "String Content",
      "PrimeSuiteUserName": "String Content",
      "PrimeSuiteUserPassword": "String Content",
      "PrimeSuiteUserAlias": "String Content"
    },
    "VendorCredential": {
      "VendorLogin": "String Content",
      "VendorPassword": "String Content"
    }
  },
  "PatientID": 0
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<FamilyBalanceGetResponse>
  <Patients>
    <PatientID>0</PatientID>
    <PatientFirstName>String Content</PatientFirstName>
    <PatientLastName>String Content</PatientLastName>
    <PatientBalance>String Content</PatientBalance>
    <CollectionsBal>String Content</CollectionsBal>
    <PatientBalanceBucket>
      <Bucket_0_TO_30>String Content</Bucket_0_TO_30>
      <Bucket_31_TO_60>String Content</Bucket_31_TO_60>
      <Bucket_61_TO_90>String Content</Bucket_61_TO_90>
      <Bucket_91_TO_120>String Content</Bucket_91_TO_120>
      <BucketOver120>String Content</BucketOver120>
    </PatientBalanceBucket>
    <Insurance>
      <InsuranceBalance>String Content</InsuranceBalance>
      <InsuranceBalanceBucket>
        <Bucket_0_TO_30>String Content</Bucket_0_TO_30>
        <Bucket_31_TO_60>String Content</Bucket_31_TO_60>
        <Bucket_61_TO_90>String Content</Bucket_61_TO_90>
        <Bucket_91_TO_120>String Content</Bucket_91_TO_120>
        <BucketOver120>String Content</BucketOver120>
      </InsuranceBalanceBucket>
    </Insurance>
    <CreditBalance>String Content</CreditBalance>
  </Patients>
</FamilyBalanceGetResponse>

Response Format: Json

Response Example (schema):

{
  "Patients": [
    {
      "PatientID": 0,
      "PatientFirstName": "String Content",
      "PatientLastName": "String Content",
      "PatientBalance": "String Content",
      "CollectionsBal": "String Content",
      "PatientBalanceBucket": {
        "Bucket_0_TO_30": "String Content",
        "Bucket_31_TO_60": "String Content",
        "Bucket_61_TO_90": "String Content",
        "Bucket_91_TO_120": "String Content",
        "BucketOver120": "String Content"
      },
      "Insurance": {
        "InsuranceBalance": "String Content",
        "InsuranceBalanceBucket": {
          "Bucket_0_TO_30": "String Content",
          "Bucket_31_TO_60": "String Content",
          "Bucket_61_TO_90": "String Content",
          "Bucket_91_TO_120": "String Content",
          "BucketOver120": "String Content"
        }
      },
      "CreditBalance": "String Content"
    }
  ]
}