|
Method |
Request URI |
HTTP Version |
|
GET |
OLD URL (will be deprecated soon): {OLD EBH domain}/statuses/api/{api version}/details NEW URL (recommended): {NEW EBH domain}/ebh/statuses/{api version}/details Api versions: v1, v2. |
HTTP/1.1 |
URI Parameters
The following table describes required and optional URI parameters.
|
Parameter |
Description |
|
InvoiceId |
Required. Billing organization’s assigned invoice numbers or codes for which to obtain status. |
Request Headers
The following table describes required and optional request headers.
|
Request header |
Description |
|
ProducerId |
Required. Specifies the client on behalf of which the request is sent. |
|
ProviderKey |
Required. Specifies the access token. |
|
Username |
Optional. Specifies the user on behalf of which the request is sent. The value is used for reporting purposes only and defined by the caller. |
|
Accept |
Optional. Specifies the expected response format. A list of valid values: application/json (default), */*. |
The response includes an HTTP status code, a set of response headers and a response body, which contains a list of invoice details.
Status Codes
A successful operation returns status code 200 (OK).
|
Status code |
Description |
|
200 OK |
The request was successful. See the response body for details. |
|
400 BAD REQUEST |
The request was incorrectly formatted, missing a required header or parameters were invalid. |
|
401 UNAUTHORIZED |
The Provider Key is not authorized. |
|
406 NOT ACCEPTABLE |
Provided Accept HTTP Header is not supported. |
|
500 INTERNAL SERVER ERROR |
Something went wrong. |
Response Headers
|
Response header |
Description |
|
OperationId |
The unique identifier associated with the request. |
Response Body
A request was successfully processed:
The response represents an array of objects.
{
"InvoiceList": {
"ListOfInvoices": [
{
"InvoiceId": "111111",
"HubReferenceNumber": 1111,
"InvoiceDate": "1/01/2020",
"StartDate": "5/15/2020",
"EndDate": "5/15/2020",
"TransmitDateTime": "",
"ApprovedDateTime": "",
"CurrentHubStatus": "RECEIVED",
"ChangeDateTime": "9/28/2021 11:43:24 AM",
"MatterId": "11111.11",
"MatterDescription": "CORPORATION",
"StatusNote": "",
"EBHRecipient": "TEST USER",
"PayorOrgEBillingId": 1234,
"TrackingNumber": "",
"Vendor": "LEGAL TRACKER API TEST",
"ClientName": "TEST CLIENT",
"ClientId": "0123",
"InvoicePrefixPostfix": "PRE111111POST"
}
],
"Count": 1
}
}
An error occurred while processing a request:
{
"Message": "An unexpected error occurred. Please, contact the support team."
}