PV API Service

<back to all web services

BillingAutoChargeChargeVisitRequest

POST the rules engine response to create the visit's invoice

The following routes are available for this service:
POST, OPTIONS/AutoChargeEntry/Billing/ChargedVisit

To override the Content-type in your clients HTTP Accept Header, append ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/BillingAutoChargeChargeVisitRequest HTTP/1.1 
Host: api.practicevelocity.com 
Content-Type: application/xml
Content-Length: length

<BillingAutoChargeChargeVisitRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.AutoChargeEntry.DataModel.Billing.AutoCharge">
  <AutoChargedEvent xmlns:d2p1="http://schemas.datacontract.org/2004/07/PV.AutoChargeEntry.DataModel.POCOs">
    <d2p1:Audit>
      <d2p1:CanAutoCharge>false</d2p1:CanAutoCharge>
      <d2p1:CanAutoCode>false</d2p1:CanAutoCode>
      <d2p1:FinalStatus>String</d2p1:FinalStatus>
      <d2p1:ManualReviewNeeded>false</d2p1:ManualReviewNeeded>
      <d2p1:RulesLogs>
        <d2p1:RulesLog>
          <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
          <d2p1:LogLevel>String</d2p1:LogLevel>
          <d2p1:Message>String</d2p1:Message>
          <d2p1:RuleGroup>String</d2p1:RuleGroup>
          <d2p1:RuleName>String</d2p1:RuleName>
          <d2p1:RulesLogId>00000000-0000-0000-0000-000000000000</d2p1:RulesLogId>
          <d2p1:Status>String</d2p1:Status>
        </d2p1:RulesLog>
      </d2p1:RulesLogs>
      <d2p1:StopProcessing>false</d2p1:StopProcessing>
      <d2p1:WithholdReason>String</d2p1:WithholdReason>
    </d2p1:Audit>
    <d2p1:EventId>00000000-0000-0000-0000-000000000000</d2p1:EventId>
    <d2p1:VisitCharged>
      <d2p1:AuthNumberFlag>false</d2p1:AuthNumberFlag>
      <d2p1:Charges>
        <d2p1:ChargeInfo>
          <d2p1:ArAmount>
            <d2p1:Amount>0</d2p1:Amount>
            <d2p1:Currency>String</d2p1:Currency>
          </d2p1:ArAmount>
          <d2p1:Billable>false</d2p1:Billable>
          <d2p1:BilltoPayer>false</d2p1:BilltoPayer>
          <d2p1:Charge>
            <d2p1:Amount>0</d2p1:Amount>
            <d2p1:Currency>String</d2p1:Currency>
          </d2p1:Charge>
          <d2p1:Cpt>String</d2p1:Cpt>
          <d2p1:FeeId>00000000-0000-0000-0000-000000000000</d2p1:FeeId>
          <d2p1:IndicatedBy>
            <d2p1:Diagnosis>
              <d2p1:DiagCodePk>00000000-0000-0000-0000-000000000000</d2p1:DiagCodePk>
              <d2p1:Icd10DiagCode>String</d2p1:Icd10DiagCode>
              <d2p1:Icd9DiagCode>String</d2p1:Icd9DiagCode>
              <d2p1:Priority>0</d2p1:Priority>
              <d2p1:Snomed>String</d2p1:Snomed>
            </d2p1:Diagnosis>
          </d2p1:IndicatedBy>
          <d2p1:Modifier xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d2p1:Modifier>
          <d2p1:Paid>
            <d2p1:Amount>0</d2p1:Amount>
            <d2p1:Currency>String</d2p1:Currency>
          </d2p1:Paid>
          <d2p1:PayerId>00000000-0000-0000-0000-000000000000</d2p1:PayerId>
          <d2p1:ProviderId>00000000-0000-0000-0000-000000000000</d2p1:ProviderId>
          <d2p1:Quantity>0</d2p1:Quantity>
        </d2p1:ChargeInfo>
      </d2p1:Charges>
      <d2p1:CreatedId>String</d2p1:CreatedId>
      <d2p1:CreatedOn>String</d2p1:CreatedOn>
      <d2p1:CreatedUserNumber>0</d2p1:CreatedUserNumber>
      <d2p1:Diagnosis>
        <d2p1:Diagnosis>
          <d2p1:DiagCodePk>00000000-0000-0000-0000-000000000000</d2p1:DiagCodePk>
          <d2p1:Icd10DiagCode>String</d2p1:Icd10DiagCode>
          <d2p1:Icd9DiagCode>String</d2p1:Icd9DiagCode>
          <d2p1:Priority>0</d2p1:Priority>
          <d2p1:Snomed>String</d2p1:Snomed>
        </d2p1:Diagnosis>
      </d2p1:Diagnosis>
      <d2p1:Payments>
        <d2p1:Payment>
          <d2p1:Amount>
            <d2p1:Amount>0</d2p1:Amount>
            <d2p1:Currency>String</d2p1:Currency>
          </d2p1:Amount>
          <d2p1:Notes>String</d2p1:Notes>
          <d2p1:PayerId>00000000-0000-0000-0000-000000000000</d2p1:PayerId>
          <d2p1:PaymentCategory>String</d2p1:PaymentCategory>
          <d2p1:PaymentId>00000000-0000-0000-0000-000000000000</d2p1:PaymentId>
          <d2p1:PaymentType>String</d2p1:PaymentType>
        </d2p1:Payment>
      </d2p1:Payments>
      <d2p1:PracticeId>00000000-0000-0000-0000-000000000000</d2p1:PracticeId>
      <d2p1:Version>String</d2p1:Version>
      <d2p1:VisitId>00000000-0000-0000-0000-000000000000</d2p1:VisitId>
      <d2p1:WcDocFlag>false</d2p1:WcDocFlag>
    </d2p1:VisitCharged>
  </AutoChargedEvent>
</BillingAutoChargeChargeVisitRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BillingAutoChargeChargeVisitResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.AutoChargeEntry.DataModel.Billing.AutoCharge">
  <Result>false</Result>
</BillingAutoChargeChargeVisitResponse>