|
Method |
Request URI |
HTTP Version |
|
POST |
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 |
|
OutputInvoiceType |
Required. The outputInvoiceType parameter specifies the expected LEDES output type. A list of valid values: LEDES98B, LEDES98BI, LEDES98BIV2, LEDES2000, LEDESXML20, LEDESXML21. |
|
CallType |
Required. The callType parameter specifies whether the LEDES file is the final or a preview one. A list of valid values: Final, Preview. |
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. |
|
Content-Type |
Required. Specifies the body format. A list of valid values: application/xml. |
|
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. |
Request Body
ESF payload (single-payor).
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 201 (Created).
|
Status code |
Description |
|
201 CREATED |
The request was created successfully. 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. |
|
415 UNSUPPORTED MEDIA TYPE |
Provided Content-Type HTTP Header is not supported. |
|
413 PAYLOAD TOO LARGE |
Too large payload size. |
|
406 NOT ACCEPTABLE |
Provided Accept HTTP Header is not supported. |
Response Headers
|
Response header |
Description |
|
Location |
The location header indicates the URL to the created resource. |
|
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."
}
An error occurred during XSD validation while processing a request:
{
"Message": "ErrorMessage",
"ModelState": {
"InvoicePayload": [
"The payload does not match expected format"
]
}
}