|
Method |
Request URI |
HTTP Version |
|
GET |
OLD URL (will be deprecated soon): {OLD EBH domain}/invoice-viewer/api/{api version}/ledes/{id} NEW URL (recommended): {NEW EBH domain}/ebh/invoice-viewer/{api version}/ledes/{id} Api versions: v1, v2. |
HTTP/1.1 |
URI Parameters
The following table describes required and optional URI parameters.
|
Parameter |
Description |
|
Id |
Required. The identifier of a successfully created LEDES file. |
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/octet-stream (default), text/plain. |
The response includes an HTTP status code, a set of response headers and a response body, which contains the content of the LEDES.
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. |
|
404 NOT FOUND |
The LEDES file was not found. |
|
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:
The response format depends on the Accept header. If the Accept header is set to application/octet-stream, then a LEDES file should start downloading. If the Accept header is set to text/plain, then a successful operation returns a LEDES file as a text.
An error occurred while processing a request:
{
"Message": "An unexpected error occurred. Please, contact the support team."
}