The Invoice Viewer REST API is designed to provide the ability to download invoice payloads in different formats (e.g. LEDES) before actual submit.

Generate LEDES

The operation creates a new LEDES file.

Request

Method Request URI HTTP Version
POST {eBHDomain}/invoice-viewer/api/v1/ledes 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).

 

Response

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"
      ]
   }
}

Get LEDES by Id

The operation returns a LEDES file by a unique identifier.

Request

Method Request URI HTTP Version
GET {eBHDomain}/invoice-viewer/api/v1/ledes/{id} 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. 

Response

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."
}

Get latest LEDES by invoice

The operation returns the latest (current) LEDES file by an invoiceId and a payorOrgId identifiers.

Request

Method Request URI HTTP Version
GET {eBHDomain}/invoice-viewer/api/v1/ledes/{invoiceId}/{payorOrgId} HTTP/1.1

URI Parameters

The following table describes required and optional URI parameters.

Parameter Description
InvoiceId

Required. The producer's invoice identifier or number.
PayorOrgId

Required. The id of the payor organization.

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. 

Response

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 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."
}

 

Get LEDES history

The operation returns a list of generate LEDES operations by filters.

Request

Method Request URI HTTP Version
GET {eBHDomain}/invoice-viewer/api/v1/ledes 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. 

Response

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."
}