|
Method |
Request URI |
HTTP Version |
|
GET |
OLD URL (will be deprecated soon): {OLD EBH domain}/invoice-viewer/api/{api version}/ledes NEW URL (recommended): {NEW EBH domain}/ebh/invoice-viewer/{api version}/ledes Api versions: v1, v2. |
HTTP/1.1 |
URI Parameters
The following table describes required and optional URI parameters.
|
Parameter |
Description |
|
InvoiceId |
Optional. The producer's invoice identifier or number. |
|
PayorOrgId |
Optional. The id of the payor organization. |
|
CallType |
Optional. The type of the LEDES file. A list of valid values: Final, Preview. |
|
StartDate |
Optional. The stand date of date range (LEDES created date). |
|
EndDate |
Optional. The end date of date range (LEDES created date). |
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. |
The response includes an HTTP status code, a set of response headers and a response body, which contains the list of LEDES operations.
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. |
Response Headers
|
Response header |
Description |
|
OperationId |
The unique identifier associated with the request. |
Response Body
A request was successfully processed:
{
"Message": "Returning the latest 100 invoices, please specify more specific criteria to narrow your results.",
"Invoices": [
{
"Id": "6F9619FF-8B86-D011-B42D-00CF4FC964FF",
"Username": "John Snow",
"InvoiceId": "33-4444",
"PayorOrgId": "36",
"OutputInvoiceType": "LEDES98B",
"CallType": "Final",
"PostTime": "2016-11-06 02:33:16.000Z"
}
]
}
An error occurred while processing a request:
{
"Message": "An unexpected error occurred. Please, contact the support team."
}