GET api/v1/{practiceid}/billing/invoicetemplates/{templateid}

Get invoice template by id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceid

Unique identifier of practice

 globally unique identifier

Required
templateid

Unique identifier of template

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Invoice template

Com.Healthbridge.Hhas.Billing.Interface.ValueObjects.InvoiceTemplateVo
NameDescriptionTypeAdditional information
TemplateId

Unique template Id

 globally unique identifier

None.
PracticeId

Practice Id for which template created

 globally unique identifier

None.
TemplateType

Template type, can be: - MyTemplate - Procedure - Diagnosis - Medicine

 string

None.
Caption

Short name for template

 string

None.
Description

Full description for template

 string

None.
SortOrder

Template Order

 integer

None.
InvoiceLineItemsVo

Com.Healthbridge.Hhas.Billing.Interface.ValueObjects.InvoiceLineItemsVo

None.

Response Formats

application/json, text/json

Sample: 
{
  "TemplateId": "65aa3b74-1eee-4612-a0f2-bf629f859a9e",
  "PracticeId": "ac41d010-dc68-459d-baff-6f2e76a52e14",
  "TemplateType": "sample string 3",
  "Caption": "sample string 4",
  "Description": "sample string 5",
  "SortOrder": 6,
  "InvoiceLineItemsVo": {
    "InvoiceHeader": {
      "ClaimAuthorizationNumber": "sample string 1",
      "AdmissionDateTime": "2025-11-23T06:23:39Z",
      "DischargeDateTime": "2025-11-23T06:23:39Z",
      "HospitalIndicator": true,
      "ClaimType": "sample string 3",
      "TariffCode": "sample string 4",
      "Diagnosis": [
        {
          "Id": "3e4ec5e7-4d4c-4a83-a877-f14fb2eb0ef1",
          "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": "3e4ec5e7-4d4c-4a83-a877-f14fb2eb0ef1",
          "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-11-23T06:23:39Z",
      "PlaceOfService": 0,
      "Ward": "sample string 6"
    },
    "LineItems": [
      {
        "DateOfService": "2025-11-23T06:23:39Z",
        "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-11-23T06:23:39Z",
        "ChargeEnd": "2025-11-23T06:23:39Z",
        "Diagnosis": [
          {
            "Id": "3e4ec5e7-4d4c-4a83-a877-f14fb2eb0ef1",
            "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": "3e4ec5e7-4d4c-4a83-a877-f14fb2eb0ef1",
            "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-11-23T06:23:39Z",
        "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-11-23T06:23:39Z",
        "ChargeEnd": "2025-11-23T06:23:39Z",
        "Diagnosis": [
          {
            "Id": "3e4ec5e7-4d4c-4a83-a877-f14fb2eb0ef1",
            "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": "3e4ec5e7-4d4c-4a83-a877-f14fb2eb0ef1",
            "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
          }
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<InvoiceTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/rcm/billing/v1/invoice/">
  <Caption>sample string 4</Caption>
  <Description>sample string 5</Description>
  <InvoiceLineItemsVo>
    <InvoiceHeader>
      <AdmissionDateTime>2025-11-23T06:23:39.7420532+02:00</AdmissionDateTime>
      <ClaimAuthorizationNumber>sample string 1</ClaimAuthorizationNumber>
      <ClaimType>sample string 3</ClaimType>
      <DateOfService>2025-11-23T06:23:39.7420532+02:00</DateOfService>
      <Diagnosis>
        <Diagnosis>
          <AgeRangeEnd>1</AgeRangeEnd>
          <AgeRangeStart>1</AgeRangeStart>
          <DiagnosisCode>sample string 2</DiagnosisCode>
          <DiagnosisDescription>sample string 3</DiagnosisDescription>
          <Gender>sample string 9</Gender>
          <Id>3e4ec5e7-4d4c-4a83-a877-f14fb2eb0ef1</Id>
          <MaxSpecificity>true</MaxSpecificity>
          <PrimaryIndicator>true</PrimaryIndicator>
          <SpecificCode>true</SpecificCode>
          <ValidPrimary>true</ValidPrimary>
          <ValidSequelae>true</ValidSequelae>
        </Diagnosis>
        <Diagnosis>
          <AgeRangeEnd>1</AgeRangeEnd>
          <AgeRangeStart>1</AgeRangeStart>
          <DiagnosisCode>sample string 2</DiagnosisCode>
          <DiagnosisDescription>sample string 3</DiagnosisDescription>
          <Gender>sample string 9</Gender>
          <Id>3e4ec5e7-4d4c-4a83-a877-f14fb2eb0ef1</Id>
          <MaxSpecificity>true</MaxSpecificity>
          <PrimaryIndicator>true</PrimaryIndicator>
          <SpecificCode>true</SpecificCode>
          <ValidPrimary>true</ValidPrimary>
          <ValidSequelae>true</ValidSequelae>
        </Diagnosis>
      </Diagnosis>
      <DischargeDateTime>2025-11-23T06:23:39.7420532+02:00</DischargeDateTime>
      <HospitalIndicator>true</HospitalIndicator>
      <PlaceOfService>Uknown</PlaceOfService>
      <TariffCode>sample string 4</TariffCode>
      <Ward>sample string 6</Ward>
    </InvoiceHeader>
    <LineItems>
      <InvoiceLineItem>
        <Amount>25</Amount>
        <ChargeCode>sample string 4</ChargeCode>
        <ChargeDesc>sample string 5</ChargeDesc>
        <ChargeEnd>2025-11-23T06:23:39.7420532+02:00</ChargeEnd>
        <ChargeQuan>18</ChargeQuan>
        <ChargeStart>2025-11-23T06:23:39.7420532+02:00</ChargeStart>
        <ChargeUnits>sample string 7</ChargeUnits>
        <ChronicIndicator>true</ChronicIndicator>
        <DateOfService>2025-11-23T06:23:39.7420532+02:00</DateOfService>
        <Diagnosis>
          <Diagnosis>
            <AgeRangeEnd>1</AgeRangeEnd>
            <AgeRangeStart>1</AgeRangeStart>
            <DiagnosisCode>sample string 2</DiagnosisCode>
            <DiagnosisDescription>sample string 3</DiagnosisDescription>
            <Gender>sample string 9</Gender>
            <Id>3e4ec5e7-4d4c-4a83-a877-f14fb2eb0ef1</Id>
            <MaxSpecificity>true</MaxSpecificity>
            <PrimaryIndicator>true</PrimaryIndicator>
            <SpecificCode>true</SpecificCode>
            <ValidPrimary>true</ValidPrimary>
            <ValidSequelae>true</ValidSequelae>
          </Diagnosis>
          <Diagnosis>
            <AgeRangeEnd>1</AgeRangeEnd>
            <AgeRangeStart>1</AgeRangeStart>
            <DiagnosisCode>sample string 2</DiagnosisCode>
            <DiagnosisDescription>sample string 3</DiagnosisDescription>
            <Gender>sample string 9</Gender>
            <Id>3e4ec5e7-4d4c-4a83-a877-f14fb2eb0ef1</Id>
            <MaxSpecificity>true</MaxSpecificity>
            <PrimaryIndicator>true</PrimaryIndicator>
            <SpecificCode>true</SpecificCode>
            <ValidPrimary>true</ValidPrimary>
            <ValidSequelae>true</ValidSequelae>
          </Diagnosis>
        </Diagnosis>
        <DosageType>sample string 9</DosageType>
        <DosageUnit>8.1</DosageUnit>
        <DurationType>sample string 15</DurationType>
        <DurationUnit>14</DurationUnit>
        <FrequencyType>sample string 11</FrequencyType>
        <FrequencyUnit>10</FrequencyUnit>
        <LineNum>2</LineNum>
        <LineType>sample string 3</LineType>
        <NappiCode>sample string 6</NappiCode>
        <Parameters xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value>sample string 4</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Parameters>
        <PeriodType>sample string 13</PeriodType>
        <PeriodUnit>12</PeriodUnit>
        <PriceOverride>true</PriceOverride>
        <Repeat>16</Repeat>
        <Responses xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value>sample string 4</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Responses>
        <SchemeRule>sample string 24</SchemeRule>
        <TotalExcVat>19</TotalExcVat>
        <TotalIncVat>21</TotalIncVat>
        <UnitPrice>22</UnitPrice>
        <VatAmount>20</VatAmount>
      </InvoiceLineItem>
      <InvoiceLineItem>
        <Amount>25</Amount>
        <ChargeCode>sample string 4</ChargeCode>
        <ChargeDesc>sample string 5</ChargeDesc>
        <ChargeEnd>2025-11-23T06:23:39.7420532+02:00</ChargeEnd>
        <ChargeQuan>18</ChargeQuan>
        <ChargeStart>2025-11-23T06:23:39.7420532+02:00</ChargeStart>
        <ChargeUnits>sample string 7</ChargeUnits>
        <ChronicIndicator>true</ChronicIndicator>
        <DateOfService>2025-11-23T06:23:39.7420532+02:00</DateOfService>
        <Diagnosis>
          <Diagnosis>
            <AgeRangeEnd>1</AgeRangeEnd>
            <AgeRangeStart>1</AgeRangeStart>
            <DiagnosisCode>sample string 2</DiagnosisCode>
            <DiagnosisDescription>sample string 3</DiagnosisDescription>
            <Gender>sample string 9</Gender>
            <Id>3e4ec5e7-4d4c-4a83-a877-f14fb2eb0ef1</Id>
            <MaxSpecificity>true</MaxSpecificity>
            <PrimaryIndicator>true</PrimaryIndicator>
            <SpecificCode>true</SpecificCode>
            <ValidPrimary>true</ValidPrimary>
            <ValidSequelae>true</ValidSequelae>
          </Diagnosis>
          <Diagnosis>
            <AgeRangeEnd>1</AgeRangeEnd>
            <AgeRangeStart>1</AgeRangeStart>
            <DiagnosisCode>sample string 2</DiagnosisCode>
            <DiagnosisDescription>sample string 3</DiagnosisDescription>
            <Gender>sample string 9</Gender>
            <Id>3e4ec5e7-4d4c-4a83-a877-f14fb2eb0ef1</Id>
            <MaxSpecificity>true</MaxSpecificity>
            <PrimaryIndicator>true</PrimaryIndicator>
            <SpecificCode>true</SpecificCode>
            <ValidPrimary>true</ValidPrimary>
            <ValidSequelae>true</ValidSequelae>
          </Diagnosis>
        </Diagnosis>
        <DosageType>sample string 9</DosageType>
        <DosageUnit>8.1</DosageUnit>
        <DurationType>sample string 15</DurationType>
        <DurationUnit>14</DurationUnit>
        <FrequencyType>sample string 11</FrequencyType>
        <FrequencyUnit>10</FrequencyUnit>
        <LineNum>2</LineNum>
        <LineType>sample string 3</LineType>
        <NappiCode>sample string 6</NappiCode>
        <Parameters xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value>sample string 4</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Parameters>
        <PeriodType>sample string 13</PeriodType>
        <PeriodUnit>12</PeriodUnit>
        <PriceOverride>true</PriceOverride>
        <Repeat>16</Repeat>
        <Responses xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value>sample string 4</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Responses>
        <SchemeRule>sample string 24</SchemeRule>
        <TotalExcVat>19</TotalExcVat>
        <TotalIncVat>21</TotalIncVat>
        <UnitPrice>22</UnitPrice>
        <VatAmount>20</VatAmount>
      </InvoiceLineItem>
    </LineItems>
  </InvoiceLineItemsVo>
  <PracticeId>ac41d010-dc68-459d-baff-6f2e76a52e14</PracticeId>
  <SortOrder>6</SortOrder>
  <TemplateId>65aa3b74-1eee-4612-a0f2-bf629f859a9e</TemplateId>
  <TemplateType>sample string 3</TemplateType>
</InvoiceTemplate>