PUT api/v1/{practiceid}/billing/invoices/{invoiceId}

Submit Invoice

Request Information

URI Parameters

Name	Description	Type	Additional information
practiceid	Unique identifier of practice	globally unique identifier	Required
invoiceId		globally unique identifier	Required

Body Parameters

public domain model = SubmitInvoice

Com.Healthbridge.Hhas.Billing.Interface.Commands.SubmitInvoice

Name	Type	Additional information
InvoiceVo	Com.Healthbridge.Hhas.Billing.Interface.ValueObjects.InvoiceVo	None.
CorrelationIds	Collection of string	None.
OriginatedSystem	string	None.

Request Formats

application/json, text/json

Sample:

{
  "InvoiceVo": {
    "InvoiceId": "7a146f52-bb08-439e-9981-c82df68a0090",
    "EncounterId": "4a674ad8-798d-46df-bd58-e17a6688d07c",
    "BranchXRef": "sample string 3",
    "PracticeId": "51994c0b-fb61-4f2a-8df2-c18c02260092",
    "InvoiceType": "sample string 5",
    "Provider": {
      "PracticeType": "sample string 1",
      "PracticeName": "sample string 2",
      "SpecialityCode": "sample string 3",
      "SubSpecialityCode": "sample string 4",
      "PracticeNumber": "sample string 5",
      "TreatingDoctorName": "sample string 6",
      "TreatingDoctorPracticeNumber": "sample string 7",
      "DispensingDoctor": "sample string 8",
      "DispensingLicenseNumber": "sample string 9",
      "HPCSANumber": "sample string 10"
    },
    "ReferringDoctorName": "sample string 6",
    "ReferringDoctorPracticeNumber": "sample string 7",
    "AssistingDoctorName": "sample string 8",
    "AssistingDoctorPracticeNumber": "sample string 9",
    "PatientEventDetails": {
      "PatientEventId": "029ababd-6df3-4d92-8f46-9bb4f94d8810",
      "PatientEventXRef": "sample string 2",
      "BranchXRef": "sample string 3",
      "BranchName": "sample string 4",
      "PracticeId": "4523ce2d-b0dc-41fa-afd0-02d3560b3535",
      "Patient": {
        "PatientId": "d806adec-e990-4fd6-a756-5e8e20c0737c",
        "PatientXRef": "sample string 2",
        "PracticeId": "63389241-3cea-4250-aa8b-95cd753fea91",
        "FileNo": "sample string 4",
        "KnownAs": "sample string 5",
        "Occupation": "sample string 6",
        "Employer": "sample string 7",
        "PreferredLanguage": "sample string 8",
        "MaritalStatus": "sample string 9",
        "PatientDetails": {
          "Title": "sample string 1",
          "FirstName": "sample string 2",
          "Surname": "sample string 3",
          "DateOfBirth": "2025-04-17T16:54:20Z",
          "IdentityNo": "sample string 5",
          "Gender": "sample string 6",
          "ContactNo": "sample string 7",
          "EmailAddress": "sample string 8"
        },
        "PatientAccountDetails": {
          "AccountId": "e0afd4bf-16aa-42eb-a440-33bc201be62c",
          "AccountNo": "sample string 2",
          "IsCashAccount": true,
          "MedicalAidName": "sample string 4",
          "MedicalAidPlan": "sample string 5",
          "MedicalAidPlanOption": "sample string 6",
          "MedicalAidMembershipNumber": "sample string 7",
          "MedicalAidDependentCode": "sample string 8",
          "MedicalAidMainMemberDetails": {
            "Title": "sample string 1",
            "FirstName": "sample string 2",
            "Surname": "sample string 3",
            "DateOfBirth": "2025-04-17T16:54:20Z",
            "IdentityNo": "sample string 5",
            "Gender": "sample string 6",
            "ContactNo": "sample string 7",
            "EmailAddress": "sample string 8"
          },
          "MedicalAidRoutingCode": "sample string 9",
          "MedicalAidOptionCode": "sample string 10",
          "MedicalAidSchemeCode": "sample string 11",
          "MedicalAidPlanCode": "sample string 12"
        },
        "PhysicalAddress": {
          "Line1": "sample string 1",
          "Line2": "sample string 2",
          "Line3": "sample string 3",
          "Code": "sample string 4"
        },
        "PostalAddress": {
          "Line1": "sample string 1",
          "Line2": "sample string 2",
          "Line3": "sample string 3",
          "Code": "sample string 4"
        },
        "Deceased": true
      },
      "ScheduledTime": "2025-04-17T16:54:20Z",
      "CheckInTime": "2025-04-17T16:54:20Z",
      "Status": 0,
      "Type": "sample string 6",
      "MedicalInsurance": {
        "MedicalInsurer": {
          "Id": "d92a306e-c18c-4764-a70b-94682b8aca01",
          "InsurerXRef": "sample string 2",
          "Name": "sample string 3",
          "AccountNo": "sample string 4",
          "Email": "sample string 5",
          "Phone1": "sample string 6",
          "Phone2": "sample string 7",
          "AddressLine1": "sample string 8",
          "AddressLine2": "sample string 9",
          "AddressLine3": "sample string 10",
          "PostalCode": "sample string 11"
        },
        "Broker": "sample string 1",
        "PolicyNo": "sample string 2",
        "PatientIdentityNo": "sample string 3"
      },
      "CompletedTime": "2025-04-17T16:54:20Z",
      "Completed": true,
      "Cancelled": true,
      "CheckedIn": true,
      "BenefitCheckStatus": "sample string 10",
      "VideoChatLink": "sample string 11",
      "BenefitCheckPdfLink": "sample string 12",
      "AccountBalance": "sample string 13",
      "ProviderNote": "sample string 14",
      "QuoteXRef": "sample string 15"
    },
    "InvoiceLineItems": {
      "InvoiceHeader": {
        "ClaimAuthorizationNumber": "sample string 1",
        "AdmissionDateTime": "2025-04-17T16:54:20Z",
        "DischargeDateTime": "2025-04-17T16:54:20Z",
        "HospitalIndicator": true,
        "ClaimType": "sample string 3",
        "TariffCode": "sample string 4",
        "Diagnosis": [
          {
            "Id": "567059f3-7f5a-4b4f-9ade-ec37f4fe2055",
            "DiagnosisCode": "sample string 2",
            "DiagnosisDescription": "sample string 3",
            "SpecificCode": true,
            "PrimaryIndicator": true,
            "ValidPrimary": true,
            "ValidSequelae": true,
            "MaxSpecificity": true,
            "Gender": "sample string 9",
            "AgeRangeStart": 1,
            "AgeRangeEnd": 1
          },
          {
            "Id": "567059f3-7f5a-4b4f-9ade-ec37f4fe2055",
            "DiagnosisCode": "sample string 2",
            "DiagnosisDescription": "sample string 3",
            "SpecificCode": true,
            "PrimaryIndicator": true,
            "ValidPrimary": true,
            "ValidSequelae": true,
            "MaxSpecificity": true,
            "Gender": "sample string 9",
            "AgeRangeStart": 1,
            "AgeRangeEnd": 1
          }
        ],
        "DateOfService": "2025-04-17T16:54:20Z",
        "PlaceOfService": 0,
        "Ward": "sample string 6"
      },
      "LineItems": [
        {
          "DateOfService": "2025-04-17T16:54:20Z",
          "LineNum": 2,
          "LineType": "sample string 3",
          "ChargeCode": "sample string 4",
          "ChargeDesc": "sample string 5",
          "NappiCode": "sample string 6",
          "ChargeUnits": "sample string 7",
          "DosageUnit": 8.1,
          "DosageType": "sample string 9",
          "FrequencyUnit": 10,
          "FrequencyType": "sample string 11",
          "PeriodUnit": 12,
          "PeriodType": "sample string 13",
          "DurationUnit": 14,
          "DurationType": "sample string 15",
          "Repeat": 16,
          "ChronicIndicator": true,
          "ChargeQuan": 18,
          "TotalExcVat": 19.0,
          "VatAmount": 20.0,
          "TotalIncVat": 21.0,
          "UnitPrice": 22.0,
          "PriceOverride": true,
          "SchemeRule": "sample string 24",
          "Amount": 25.0,
          "Parameters": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "Responses": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "ChargeStart": "2025-04-17T16:54:20Z",
          "ChargeEnd": "2025-04-17T16:54:20Z",
          "Diagnosis": [
            {
              "Id": "567059f3-7f5a-4b4f-9ade-ec37f4fe2055",
              "DiagnosisCode": "sample string 2",
              "DiagnosisDescription": "sample string 3",
              "SpecificCode": true,
              "PrimaryIndicator": true,
              "ValidPrimary": true,
              "ValidSequelae": true,
              "MaxSpecificity": true,
              "Gender": "sample string 9",
              "AgeRangeStart": 1,
              "AgeRangeEnd": 1
            },
            {
              "Id": "567059f3-7f5a-4b4f-9ade-ec37f4fe2055",
              "DiagnosisCode": "sample string 2",
              "DiagnosisDescription": "sample string 3",
              "SpecificCode": true,
              "PrimaryIndicator": true,
              "ValidPrimary": true,
              "ValidSequelae": true,
              "MaxSpecificity": true,
              "Gender": "sample string 9",
              "AgeRangeStart": 1,
              "AgeRangeEnd": 1
            }
          ]
        },
        {
          "DateOfService": "2025-04-17T16:54:20Z",
          "LineNum": 2,
          "LineType": "sample string 3",
          "ChargeCode": "sample string 4",
          "ChargeDesc": "sample string 5",
          "NappiCode": "sample string 6",
          "ChargeUnits": "sample string 7",
          "DosageUnit": 8.1,
          "DosageType": "sample string 9",
          "FrequencyUnit": 10,
          "FrequencyType": "sample string 11",
          "PeriodUnit": 12,
          "PeriodType": "sample string 13",
          "DurationUnit": 14,
          "DurationType": "sample string 15",
          "Repeat": 16,
          "ChronicIndicator": true,
          "ChargeQuan": 18,
          "TotalExcVat": 19.0,
          "VatAmount": 20.0,
          "TotalIncVat": 21.0,
          "UnitPrice": 22.0,
          "PriceOverride": true,
          "SchemeRule": "sample string 24",
          "Amount": 25.0,
          "Parameters": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "Responses": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "ChargeStart": "2025-04-17T16:54:20Z",
          "ChargeEnd": "2025-04-17T16:54:20Z",
          "Diagnosis": [
            {
              "Id": "567059f3-7f5a-4b4f-9ade-ec37f4fe2055",
              "DiagnosisCode": "sample string 2",
              "DiagnosisDescription": "sample string 3",
              "SpecificCode": true,
              "PrimaryIndicator": true,
              "ValidPrimary": true,
              "ValidSequelae": true,
              "MaxSpecificity": true,
              "Gender": "sample string 9",
              "AgeRangeStart": 1,
              "AgeRangeEnd": 1
            },
            {
              "Id": "567059f3-7f5a-4b4f-9ade-ec37f4fe2055",
              "DiagnosisCode": "sample string 2",
              "DiagnosisDescription": "sample string 3",
              "SpecificCode": true,
              "PrimaryIndicator": true,
              "ValidPrimary": true,
              "ValidSequelae": true,
              "MaxSpecificity": true,
              "Gender": "sample string 9",
              "AgeRangeStart": 1,
              "AgeRangeEnd": 1
            }
          ]
        }
      ]
    },
    "MedicalInsurance": {
      "MedicalInsurer": {
        "Id": "d92a306e-c18c-4764-a70b-94682b8aca01",
        "InsurerXRef": "sample string 2",
        "Name": "sample string 3",
        "AccountNo": "sample string 4",
        "Email": "sample string 5",
        "Phone1": "sample string 6",
        "Phone2": "sample string 7",
        "AddressLine1": "sample string 8",
        "AddressLine2": "sample string 9",
        "AddressLine3": "sample string 10",
        "PostalCode": "sample string 11"
      },
      "Broker": "sample string 1",
      "PolicyNo": "sample string 2",
      "PatientIdentityNo": "sample string 3"
    },
    "RequiresFollowUp": true,
    "Note": "sample string 11",
    "PatientDocuments": [
      {
        "DocumentUrl": "sample string 1",
        "Category": "sample string 2"
      },
      {
        "DocumentUrl": "sample string 1",
        "Category": "sample string 2"
      }
    ]
  },
  "CorrelationIds": [
    "sample string 1",
    "sample string 2"
  ],
  "OriginatedSystem": "sample string 1"
}

application/xml, text/xml

Sample:

<SubmitInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Billing.Interface.Commands">
  <CorrelationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CorrelationIds>
  <OriginatedSystem xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">sample string 1</OriginatedSystem>
  <InvoiceVo xmlns:d2p1="http://mpsapi.healthbridge.com/rcm/billing/v1/invoice/">
    <d2p1:AssistingDoctorName>sample string 8</d2p1:AssistingDoctorName>
    <d2p1:AssistingDoctorPracticeNumber>sample string 9</d2p1:AssistingDoctorPracticeNumber>
    <d2p1:BranchXRef>sample string 3</d2p1:BranchXRef>
    <d2p1:EncounterId>4a674ad8-798d-46df-bd58-e17a6688d07c</d2p1:EncounterId>
    <d2p1:InvoiceId>7a146f52-bb08-439e-9981-c82df68a0090</d2p1:InvoiceId>
    <d2p1:InvoiceLineItems>
      <d2p1:InvoiceHeader>
        <d2p1:AdmissionDateTime>2025-04-17T16:54:20.1926624+02:00</d2p1:AdmissionDateTime>
        <d2p1:ClaimAuthorizationNumber>sample string 1</d2p1:ClaimAuthorizationNumber>
        <d2p1:ClaimType>sample string 3</d2p1:ClaimType>
        <d2p1:DateOfService>2025-04-17T16:54:20.1926624+02:00</d2p1:DateOfService>
        <d2p1:Diagnosis>
          <d2p1:Diagnosis>
            <d2p1:AgeRangeEnd>1</d2p1:AgeRangeEnd>
            <d2p1:AgeRangeStart>1</d2p1:AgeRangeStart>
            <d2p1:DiagnosisCode>sample string 2</d2p1:DiagnosisCode>
            <d2p1:DiagnosisDescription>sample string 3</d2p1:DiagnosisDescription>
            <d2p1:Gender>sample string 9</d2p1:Gender>
            <d2p1:Id>567059f3-7f5a-4b4f-9ade-ec37f4fe2055</d2p1:Id>
            <d2p1:MaxSpecificity>true</d2p1:MaxSpecificity>
            <d2p1:PrimaryIndicator>true</d2p1:PrimaryIndicator>
            <d2p1:SpecificCode>true</d2p1:SpecificCode>
            <d2p1:ValidPrimary>true</d2p1:ValidPrimary>
            <d2p1:ValidSequelae>true</d2p1:ValidSequelae>
          </d2p1:Diagnosis>
          <d2p1:Diagnosis>
            <d2p1:AgeRangeEnd>1</d2p1:AgeRangeEnd>
            <d2p1:AgeRangeStart>1</d2p1:AgeRangeStart>
            <d2p1:DiagnosisCode>sample string 2</d2p1:DiagnosisCode>
            <d2p1:DiagnosisDescription>sample string 3</d2p1:DiagnosisDescription>
            <d2p1:Gender>sample string 9</d2p1:Gender>
            <d2p1:Id>567059f3-7f5a-4b4f-9ade-ec37f4fe2055</d2p1:Id>
            <d2p1:MaxSpecificity>true</d2p1:MaxSpecificity>
            <d2p1:PrimaryIndicator>true</d2p1:PrimaryIndicator>
            <d2p1:SpecificCode>true</d2p1:SpecificCode>
            <d2p1:ValidPrimary>true</d2p1:ValidPrimary>
            <d2p1:ValidSequelae>true</d2p1:ValidSequelae>
          </d2p1:Diagnosis>
        </d2p1:Diagnosis>
        <d2p1:DischargeDateTime>2025-04-17T16:54:20.1926624+02:00</d2p1:DischargeDateTime>
        <d2p1:HospitalIndicator>true</d2p1:HospitalIndicator>
        <d2p1:PlaceOfService>Uknown</d2p1:PlaceOfService>
        <d2p1:TariffCode>sample string 4</d2p1:TariffCode>
        <d2p1:Ward>sample string 6</d2p1:Ward>
      </d2p1:InvoiceHeader>
      <d2p1:LineItems>
        <d2p1:InvoiceLineItem>
          <d2p1:Amount>25</d2p1:Amount>
          <d2p1:ChargeCode>sample string 4</d2p1:ChargeCode>
          <d2p1:ChargeDesc>sample string 5</d2p1:ChargeDesc>
          <d2p1:ChargeEnd>2025-04-17T16:54:20.1926624+02:00</d2p1:ChargeEnd>
          <d2p1:ChargeQuan>18</d2p1:ChargeQuan>
          <d2p1:ChargeStart>2025-04-17T16:54:20.1926624+02:00</d2p1:ChargeStart>
          <d2p1:ChargeUnits>sample string 7</d2p1:ChargeUnits>
          <d2p1:ChronicIndicator>true</d2p1:ChronicIndicator>
          <d2p1:DateOfService>2025-04-17T16:54:20.1926624+02:00</d2p1:DateOfService>
          <d2p1:Diagnosis>
            <d2p1:Diagnosis>
              <d2p1:AgeRangeEnd>1</d2p1:AgeRangeEnd>
              <d2p1:AgeRangeStart>1</d2p1:AgeRangeStart>
              <d2p1:DiagnosisCode>sample string 2</d2p1:DiagnosisCode>
              <d2p1:DiagnosisDescription>sample string 3</d2p1:DiagnosisDescription>
              <d2p1:Gender>sample string 9</d2p1:Gender>
              <d2p1:Id>567059f3-7f5a-4b4f-9ade-ec37f4fe2055</d2p1:Id>
              <d2p1:MaxSpecificity>true</d2p1:MaxSpecificity>
              <d2p1:PrimaryIndicator>true</d2p1:PrimaryIndicator>
              <d2p1:SpecificCode>true</d2p1:SpecificCode>
              <d2p1:ValidPrimary>true</d2p1:ValidPrimary>
              <d2p1:ValidSequelae>true</d2p1:ValidSequelae>
            </d2p1:Diagnosis>
            <d2p1:Diagnosis>
              <d2p1:AgeRangeEnd>1</d2p1:AgeRangeEnd>
              <d2p1:AgeRangeStart>1</d2p1:AgeRangeStart>
              <d2p1:DiagnosisCode>sample string 2</d2p1:DiagnosisCode>
              <d2p1:DiagnosisDescription>sample string 3</d2p1:DiagnosisDescription>
              <d2p1:Gender>sample string 9</d2p1:Gender>
              <d2p1:Id>567059f3-7f5a-4b4f-9ade-ec37f4fe2055</d2p1:Id>
              <d2p1:MaxSpecificity>true</d2p1:MaxSpecificity>
              <d2p1:PrimaryIndicator>true</d2p1:PrimaryIndicator>
              <d2p1:SpecificCode>true</d2p1:SpecificCode>
              <d2p1:ValidPrimary>true</d2p1:ValidPrimary>
              <d2p1:ValidSequelae>true</d2p1:ValidSequelae>
            </d2p1:Diagnosis>
          </d2p1:Diagnosis>
          <d2p1:DosageType>sample string 9</d2p1:DosageType>
          <d2p1:DosageUnit>8.1</d2p1:DosageUnit>
          <d2p1:DurationType>sample string 15</d2p1:DurationType>
          <d2p1:DurationUnit>14</d2p1:DurationUnit>
          <d2p1:FrequencyType>sample string 11</d2p1:FrequencyType>
          <d2p1:FrequencyUnit>10</d2p1:FrequencyUnit>
          <d2p1:LineNum>2</d2p1:LineNum>
          <d2p1:LineType>sample string 3</d2p1:LineType>
          <d2p1:NappiCode>sample string 6</d2p1:NappiCode>
          <d2p1:Parameters xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 1</d6p1:Key>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d2p1:Parameters>
          <d2p1:PeriodType>sample string 13</d2p1:PeriodType>
          <d2p1:PeriodUnit>12</d2p1:PeriodUnit>
          <d2p1:PriceOverride>true</d2p1:PriceOverride>
          <d2p1:Repeat>16</d2p1:Repeat>
          <d2p1:Responses xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 1</d6p1:Key>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d2p1:Responses>
          <d2p1:SchemeRule>sample string 24</d2p1:SchemeRule>
          <d2p1:TotalExcVat>19</d2p1:TotalExcVat>
          <d2p1:TotalIncVat>21</d2p1:TotalIncVat>
          <d2p1:UnitPrice>22</d2p1:UnitPrice>
          <d2p1:VatAmount>20</d2p1:VatAmount>
        </d2p1:InvoiceLineItem>
        <d2p1:InvoiceLineItem>
          <d2p1:Amount>25</d2p1:Amount>
          <d2p1:ChargeCode>sample string 4</d2p1:ChargeCode>
          <d2p1:ChargeDesc>sample string 5</d2p1:ChargeDesc>
          <d2p1:ChargeEnd>2025-04-17T16:54:20.1926624+02:00</d2p1:ChargeEnd>
          <d2p1:ChargeQuan>18</d2p1:ChargeQuan>
          <d2p1:ChargeStart>2025-04-17T16:54:20.1926624+02:00</d2p1:ChargeStart>
          <d2p1:ChargeUnits>sample string 7</d2p1:ChargeUnits>
          <d2p1:ChronicIndicator>true</d2p1:ChronicIndicator>
          <d2p1:DateOfService>2025-04-17T16:54:20.1926624+02:00</d2p1:DateOfService>
          <d2p1:Diagnosis>
            <d2p1:Diagnosis>
              <d2p1:AgeRangeEnd>1</d2p1:AgeRangeEnd>
              <d2p1:AgeRangeStart>1</d2p1:AgeRangeStart>
              <d2p1:DiagnosisCode>sample string 2</d2p1:DiagnosisCode>
              <d2p1:DiagnosisDescription>sample string 3</d2p1:DiagnosisDescription>
              <d2p1:Gender>sample string 9</d2p1:Gender>
              <d2p1:Id>567059f3-7f5a-4b4f-9ade-ec37f4fe2055</d2p1:Id>
              <d2p1:MaxSpecificity>true</d2p1:MaxSpecificity>
              <d2p1:PrimaryIndicator>true</d2p1:PrimaryIndicator>
              <d2p1:SpecificCode>true</d2p1:SpecificCode>
              <d2p1:ValidPrimary>true</d2p1:ValidPrimary>
              <d2p1:ValidSequelae>true</d2p1:ValidSequelae>
            </d2p1:Diagnosis>
            <d2p1:Diagnosis>
              <d2p1:AgeRangeEnd>1</d2p1:AgeRangeEnd>
              <d2p1:AgeRangeStart>1</d2p1:AgeRangeStart>
              <d2p1:DiagnosisCode>sample string 2</d2p1:DiagnosisCode>
              <d2p1:DiagnosisDescription>sample string 3</d2p1:DiagnosisDescription>
              <d2p1:Gender>sample string 9</d2p1:Gender>
              <d2p1:Id>567059f3-7f5a-4b4f-9ade-ec37f4fe2055</d2p1:Id>
              <d2p1:MaxSpecificity>true</d2p1:MaxSpecificity>
              <d2p1:PrimaryIndicator>true</d2p1:PrimaryIndicator>
              <d2p1:SpecificCode>true</d2p1:SpecificCode>
              <d2p1:ValidPrimary>true</d2p1:ValidPrimary>
              <d2p1:ValidSequelae>true</d2p1:ValidSequelae>
            </d2p1:Diagnosis>
          </d2p1:Diagnosis>
          <d2p1:DosageType>sample string 9</d2p1:DosageType>
          <d2p1:DosageUnit>8.1</d2p1:DosageUnit>
          <d2p1:DurationType>sample string 15</d2p1:DurationType>
          <d2p1:DurationUnit>14</d2p1:DurationUnit>
          <d2p1:FrequencyType>sample string 11</d2p1:FrequencyType>
          <d2p1:FrequencyUnit>10</d2p1:FrequencyUnit>
          <d2p1:LineNum>2</d2p1:LineNum>
          <d2p1:LineType>sample string 3</d2p1:LineType>
          <d2p1:NappiCode>sample string 6</d2p1:NappiCode>
          <d2p1:Parameters xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 1</d6p1:Key>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d2p1:Parameters>
          <d2p1:PeriodType>sample string 13</d2p1:PeriodType>
          <d2p1:PeriodUnit>12</d2p1:PeriodUnit>
          <d2p1:PriceOverride>true</d2p1:PriceOverride>
          <d2p1:Repeat>16</d2p1:Repeat>
          <d2p1:Responses xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 1</d6p1:Key>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d2p1:Responses>
          <d2p1:SchemeRule>sample string 24</d2p1:SchemeRule>
          <d2p1:TotalExcVat>19</d2p1:TotalExcVat>
          <d2p1:TotalIncVat>21</d2p1:TotalIncVat>
          <d2p1:UnitPrice>22</d2p1:UnitPrice>
          <d2p1:VatAmount>20</d2p1:VatAmount>
        </d2p1:InvoiceLineItem>
      </d2p1:LineItems>
    </d2p1:InvoiceLineItems>
    <d2p1:InvoiceType>sample string 5</d2p1:InvoiceType>
    <d2p1:MedicalInsurance xmlns:d3p1="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.PatientEvent.Interface.ValueObjects">
      <d3p1:Broker>sample string 1</d3p1:Broker>
      <d3p1:MedicalInsurer>
        <d3p1:AccountNo>sample string 4</d3p1:AccountNo>
        <d3p1:AddressLine1>sample string 8</d3p1:AddressLine1>
        <d3p1:AddressLine2>sample string 9</d3p1:AddressLine2>
        <d3p1:AddressLine3>sample string 10</d3p1:AddressLine3>
        <d3p1:Email>sample string 5</d3p1:Email>
        <d3p1:Id>d92a306e-c18c-4764-a70b-94682b8aca01</d3p1:Id>
        <d3p1:InsurerXRef>sample string 2</d3p1:InsurerXRef>
        <d3p1:Name>sample string 3</d3p1:Name>
        <d3p1:Phone1>sample string 6</d3p1:Phone1>
        <d3p1:Phone2>sample string 7</d3p1:Phone2>
        <d3p1:PostalCode>sample string 11</d3p1:PostalCode>
      </d3p1:MedicalInsurer>
      <d3p1:PatientIdentityNo>sample string 3</d3p1:PatientIdentityNo>
      <d3p1:PolicyNo>sample string 2</d3p1:PolicyNo>
    </d2p1:MedicalInsurance>
    <d2p1:Note>sample string 11</d2p1:Note>
    <d2p1:PatientDocuments xmlns:d3p1="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Billing.Interface.ValueObjects">
      <d3p1:LinkedPatientDocument>
        <d3p1:Category>sample string 2</d3p1:Category>
        <d3p1:DocumentUrl>sample string 1</d3p1:DocumentUrl>
      </d3p1:LinkedPatientDocument>
      <d3p1:LinkedPatientDocument>
        <d3p1:Category>sample string 2</d3p1:Category>
        <d3p1:DocumentUrl>sample string 1</d3p1:DocumentUrl>
      </d3p1:LinkedPatientDocument>
    </d2p1:PatientDocuments>
    <d2p1:PatientEventDetails xmlns:d3p1="http://mpsapi.healthbridge.com/clinical/patientevent/v1/patientevent/">
      <d3p1:AccountBalance>sample string 13</d3p1:AccountBalance>
      <d3p1:BenefitCheckPdfLink>sample string 12</d3p1:BenefitCheckPdfLink>
      <d3p1:BenefitCheckStatus>sample string 10</d3p1:BenefitCheckStatus>
      <d3p1:BranchName>sample string 4</d3p1:BranchName>
      <d3p1:BranchXRef>sample string 3</d3p1:BranchXRef>
      <d3p1:Cancelled>true</d3p1:Cancelled>
      <d3p1:CheckInTime>2025-04-17T16:54:20.1926624+02:00</d3p1:CheckInTime>
      <d3p1:CheckedIn>true</d3p1:CheckedIn>
      <d3p1:Completed>true</d3p1:Completed>
      <d3p1:CompletedTime>2025-04-17T16:54:20.1926624+02:00</d3p1:CompletedTime>
      <d3p1:MedicalInsurance xmlns:d4p1="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.PatientEvent.Interface.ValueObjects">
        <d4p1:Broker>sample string 1</d4p1:Broker>
        <d4p1:MedicalInsurer>
          <d4p1:AccountNo>sample string 4</d4p1:AccountNo>
          <d4p1:AddressLine1>sample string 8</d4p1:AddressLine1>
          <d4p1:AddressLine2>sample string 9</d4p1:AddressLine2>
          <d4p1:AddressLine3>sample string 10</d4p1:AddressLine3>
          <d4p1:Email>sample string 5</d4p1:Email>
          <d4p1:Id>d92a306e-c18c-4764-a70b-94682b8aca01</d4p1:Id>
          <d4p1:InsurerXRef>sample string 2</d4p1:InsurerXRef>
          <d4p1:Name>sample string 3</d4p1:Name>
          <d4p1:Phone1>sample string 6</d4p1:Phone1>
          <d4p1:Phone2>sample string 7</d4p1:Phone2>
          <d4p1:PostalCode>sample string 11</d4p1:PostalCode>
        </d4p1:MedicalInsurer>
        <d4p1:PatientIdentityNo>sample string 3</d4p1:PatientIdentityNo>
        <d4p1:PolicyNo>sample string 2</d4p1:PolicyNo>
      </d3p1:MedicalInsurance>
      <d3p1:Patient xmlns:d4p1="http://mpsapi.healthbridge.com/clinical/patient/v1/patient/">
        <d4p1:Deceased>true</d4p1:Deceased>
        <d4p1:Employer>sample string 7</d4p1:Employer>
        <d4p1:FileNo>sample string 4</d4p1:FileNo>
        <d4p1:KnownAs>sample string 5</d4p1:KnownAs>
        <d4p1:MaritalStatus>sample string 9</d4p1:MaritalStatus>
        <d4p1:Occupation>sample string 6</d4p1:Occupation>
        <d4p1:PatientAccountDetails>
          <d4p1:AccountId>e0afd4bf-16aa-42eb-a440-33bc201be62c</d4p1:AccountId>
          <d4p1:AccountNo>sample string 2</d4p1:AccountNo>
          <d4p1:IsCashAccount>true</d4p1:IsCashAccount>
          <d4p1:MedicalAidDependentCode>sample string 8</d4p1:MedicalAidDependentCode>
          <d4p1:MedicalAidMainMemberDetails>
            <d4p1:ContactNo>sample string 7</d4p1:ContactNo>
            <d4p1:DateOfBirth>2025-04-17T16:54:20.1926624+02:00</d4p1:DateOfBirth>
            <d4p1:EmailAddress>sample string 8</d4p1:EmailAddress>
            <d4p1:FirstName>sample string 2</d4p1:FirstName>
            <d4p1:Gender>sample string 6</d4p1:Gender>
            <d4p1:IdentityNo>sample string 5</d4p1:IdentityNo>
            <d4p1:Surname>sample string 3</d4p1:Surname>
            <d4p1:Title>sample string 1</d4p1:Title>
          </d4p1:MedicalAidMainMemberDetails>
          <d4p1:MedicalAidMembershipNumber>sample string 7</d4p1:MedicalAidMembershipNumber>
          <d4p1:MedicalAidName>sample string 4</d4p1:MedicalAidName>
          <d4p1:MedicalAidOptionCode>sample string 10</d4p1:MedicalAidOptionCode>
          <d4p1:MedicalAidPlan>sample string 5</d4p1:MedicalAidPlan>
          <d4p1:MedicalAidPlanCode>sample string 12</d4p1:MedicalAidPlanCode>
          <d4p1:MedicalAidPlanOption>sample string 6</d4p1:MedicalAidPlanOption>
          <d4p1:MedicalAidRoutingCode>sample string 9</d4p1:MedicalAidRoutingCode>
          <d4p1:MedicalAidSchemeCode>sample string 11</d4p1:MedicalAidSchemeCode>
        </d4p1:PatientAccountDetails>
        <d4p1:PatientDetails>
          <d4p1:ContactNo>sample string 7</d4p1:ContactNo>
          <d4p1:DateOfBirth>2025-04-17T16:54:20.1926624+02:00</d4p1:DateOfBirth>
          <d4p1:EmailAddress>sample string 8</d4p1:EmailAddress>
          <d4p1:FirstName>sample string 2</d4p1:FirstName>
          <d4p1:Gender>sample string 6</d4p1:Gender>
          <d4p1:IdentityNo>sample string 5</d4p1:IdentityNo>
          <d4p1:Surname>sample string 3</d4p1:Surname>
          <d4p1:Title>sample string 1</d4p1:Title>
        </d4p1:PatientDetails>
        <d4p1:PatientId>d806adec-e990-4fd6-a756-5e8e20c0737c</d4p1:PatientId>
        <d4p1:PatientXRef>sample string 2</d4p1:PatientXRef>
        <d4p1:PhysicalAddress>
          <d4p1:Code>sample string 4</d4p1:Code>
          <d4p1:Line1>sample string 1</d4p1:Line1>
          <d4p1:Line2>sample string 2</d4p1:Line2>
          <d4p1:Line3>sample string 3</d4p1:Line3>
        </d4p1:PhysicalAddress>
        <d4p1:PostalAddress>
          <d4p1:Code>sample string 4</d4p1:Code>
          <d4p1:Line1>sample string 1</d4p1:Line1>
          <d4p1:Line2>sample string 2</d4p1:Line2>
          <d4p1:Line3>sample string 3</d4p1:Line3>
        </d4p1:PostalAddress>
        <d4p1:PracticeId>63389241-3cea-4250-aa8b-95cd753fea91</d4p1:PracticeId>
        <d4p1:PreferredLanguage>sample string 8</d4p1:PreferredLanguage>
      </d3p1:Patient>
      <d3p1:PatientEventId>029ababd-6df3-4d92-8f46-9bb4f94d8810</d3p1:PatientEventId>
      <d3p1:PatientEventXRef>sample string 2</d3p1:PatientEventXRef>
      <d3p1:PracticeId>4523ce2d-b0dc-41fa-afd0-02d3560b3535</d3p1:PracticeId>
      <d3p1:ProviderNote>sample string 14</d3p1:ProviderNote>
      <d3p1:QuoteXRef>sample string 15</d3p1:QuoteXRef>
      <d3p1:ScheduledTime>2025-04-17T16:54:20.1926624+02:00</d3p1:ScheduledTime>
      <d3p1:Status>Scheduled</d3p1:Status>
      <d3p1:Type>sample string 6</d3p1:Type>
      <d3p1:VideoChatLink>sample string 11</d3p1:VideoChatLink>
    </d2p1:PatientEventDetails>
    <d2p1:PracticeId>51994c0b-fb61-4f2a-8df2-c18c02260092</d2p1:PracticeId>
    <d2p1:Provider>
      <d2p1:DispensingDoctor>sample string 8</d2p1:DispensingDoctor>
      <d2p1:DispensingLicenseNumber>sample string 9</d2p1:DispensingLicenseNumber>
      <d2p1:HPCSANumber>sample string 10</d2p1:HPCSANumber>
      <d2p1:PracticeName>sample string 2</d2p1:PracticeName>
      <d2p1:PracticeNumber>sample string 5</d2p1:PracticeNumber>
      <d2p1:PracticeType>sample string 1</d2p1:PracticeType>
      <d2p1:SpecialityCode>sample string 3</d2p1:SpecialityCode>
      <d2p1:SubSpecialityCode>sample string 4</d2p1:SubSpecialityCode>
      <d2p1:TreatingDoctorName>sample string 6</d2p1:TreatingDoctorName>
      <d2p1:TreatingDoctorPracticeNumber>sample string 7</d2p1:TreatingDoctorPracticeNumber>
    </d2p1:Provider>
    <d2p1:ReferringDoctorName>sample string 6</d2p1:ReferringDoctorName>
    <d2p1:ReferringDoctorPracticeNumber>sample string 7</d2p1:ReferringDoctorPracticeNumber>
    <d2p1:RequiresFollowUp>true</d2p1:RequiresFollowUp>
  </InvoiceVo>
</SubmitInvoice>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'SubmitInvoice'.

Response Information

Resource Description

Id the invoice

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfSystem.Guid

Name	Type	Additional information
Sucess	boolean	None.
ResponseCode	integer	None.
ResponseMessage	string	None.
Data	globally unique identifier	None.
Links	Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiLink	None.

Response Formats

application/json, text/json

Sample:

{
  "Sucess": true,
  "ResponseCode": 2,
  "ResponseMessage": "sample string 3",
  "Data": "938774f2-bbd5-4358-bcbe-6f5c69292a61",
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<RestApiResultOfguid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data>938774f2-bbd5-4358-bcbe-6f5c69292a61</Data>
  <Links>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
  </Links>
  <ResponseCode>2</ResponseCode>
  <ResponseMessage>sample string 3</ResponseMessage>
  <Sucess>true</Sucess>
</RestApiResultOfguid>

URI parameters

Headers | Add header

Body

Status

Headers

Body

PUT api/v1/{practiceid}/billing/invoices/{invoiceId}

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml