GET api/v1/billing/invoices/failed

Return list of invoices which failed to send (available for admins)

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Com.Healthbridge.Hhas.Billing.Interface.ValueObjects.InvoiceSendingStatusVo
NameDescriptionTypeAdditional information
PracticeId

globally unique identifier

None.
EncounterId

globally unique identifier

None.
InvoiceId

globally unique identifier

None.
Reason

string

None.
Status

string

None.
System

string

None.
SendingTime

date

None.
SendingAttempts

integer

None.
SendingType

string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "PracticeId": "bc3c46ba-1eb0-4fe9-9a37-4730aa4175eb",
    "EncounterId": "605aef8a-ee8f-4a5b-9674-b25699ad0f84",
    "InvoiceId": "8dfbb280-2156-4339-a7dc-bad420db5843",
    "Reason": "sample string 4",
    "Status": "sample string 5",
    "System": "sample string 6",
    "SendingTime": "2025-06-18T19:41:02Z",
    "SendingAttempts": 8,
    "SendingType": "sample string 9"
  },
  {
    "PracticeId": "bc3c46ba-1eb0-4fe9-9a37-4730aa4175eb",
    "EncounterId": "605aef8a-ee8f-4a5b-9674-b25699ad0f84",
    "InvoiceId": "8dfbb280-2156-4339-a7dc-bad420db5843",
    "Reason": "sample string 4",
    "Status": "sample string 5",
    "System": "sample string 6",
    "SendingTime": "2025-06-18T19:41:02Z",
    "SendingAttempts": 8,
    "SendingType": "sample string 9"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfInvoiceSendingStatusVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Billing.Interface.ValueObjects">
  <InvoiceSendingStatusVo>
    <EncounterId>605aef8a-ee8f-4a5b-9674-b25699ad0f84</EncounterId>
    <InvoiceId>8dfbb280-2156-4339-a7dc-bad420db5843</InvoiceId>
    <PracticeId>bc3c46ba-1eb0-4fe9-9a37-4730aa4175eb</PracticeId>
    <Reason>sample string 4</Reason>
    <SendingAttempts>8</SendingAttempts>
    <SendingTime>2025-06-18T19:41:02.2436764+02:00</SendingTime>
    <SendingType>sample string 9</SendingType>
    <Status>sample string 5</Status>
    <System>sample string 6</System>
  </InvoiceSendingStatusVo>
  <InvoiceSendingStatusVo>
    <EncounterId>605aef8a-ee8f-4a5b-9674-b25699ad0f84</EncounterId>
    <InvoiceId>8dfbb280-2156-4339-a7dc-bad420db5843</InvoiceId>
    <PracticeId>bc3c46ba-1eb0-4fe9-9a37-4730aa4175eb</PracticeId>
    <Reason>sample string 4</Reason>
    <SendingAttempts>8</SendingAttempts>
    <SendingTime>2025-06-18T19:41:02.2436764+02:00</SendingTime>
    <SendingType>sample string 9</SendingType>
    <Status>sample string 5</Status>
    <System>sample string 6</System>
  </InvoiceSendingStatusVo>
</ArrayOfInvoiceSendingStatusVo>