POST api/v1/{practiceid}/billing/invoices/{invoiceId}/abort

Trigger command to abort invoice sending to external system

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceid

Unique identifier of practice

 globally unique identifier

Required
invoiceId

Unique identifier of invoice

 globally unique identifier

Required

Body Parameters

Com.Healthbridge.Hhas.Billing.Interface.Commands.AbortInvoiceProcessing
NameDescriptionTypeAdditional information
InvoiceId

globally unique identifier

None.
PracticeId

globally unique identifier

None.
Reason

string

None.
CorrelationIds

Collection of string

None.
OriginatedSystem

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "InvoiceId": "9ac894f8-c1d7-4096-9493-75f316e41235",
  "PracticeId": "b0bdb3ce-d746-4c8f-a98d-3c08a10f1fa2",
  "Reason": "sample string 3",
  "CorrelationIds": [
    "sample string 1",
    "sample string 2"
  ],
  "OriginatedSystem": "sample string 4"
}

application/xml, text/xml

Sample: 
<AbortInvoiceProcessing 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 4</OriginatedSystem>
  <InvoiceId>9ac894f8-c1d7-4096-9493-75f316e41235</InvoiceId>
  <PracticeId>b0bdb3ce-d746-4c8f-a98d-3c08a10f1fa2</PracticeId>
  <Reason>sample string 3</Reason>
</AbortInvoiceProcessing>

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 'AbortInvoiceProcessing'.

Response Information

Resource Description

Id the invoice

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfSystem.Guid
NameDescriptionTypeAdditional 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": "7fbf184f-2b14-42d6-9c90-8889d3101413",
  "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>7fbf184f-2b14-42d6-9c90-8889d3101413</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>