REQUEST

Method	Request URI	HTTP Version
POST	OLD URL (will be deprecated soon): {OLD EBH domain}/statuses/api/{api version}/search NEW URL (recommended): {NEW EBH domain}/ebh/statuses/{api version}/search Api versions: v1, v2.	HTTP/1.1

Method

Request URI

HTTP Version

POST

OLD URL (will be deprecated soon):

{OLD EBH domain}/statuses/api/{api version}/search

NEW URL (recommended):

{NEW EBH domain}/ebh/statuses/{api version}/search

Api versions: v1, v2.

HTTP/1.1

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/json.
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), /.

Request Body

The following table describes required and optional body string parameters.

Parameter	Description
PayorOrgId	Optional. The payor organization's id for which to obtain status.
PayorOrgEBillingId	Optional. The payor organization's ebilling id for which to obtain status.
SubmissionId	Optional. The array of ids, returned in the response from Submission API POST request, for which to obtain status.
InvoiceId	Optional. The array of invoice numbers or codes, assigned by the billing organization, for which to obtain status.
MatterId	Optional. The array of matter ids or case reference numbers, assigned by the billing organization, for which to obtain status.
StartDate	Optional. The start date of the invoice status change date range in UTC format.
EndDate	Optional. The end date of the invoice status change date range in UTC format.
IsActive	Optional. Specifies whether the result selection will contain invoices in an active state only. The default value is false.

{
    "submissionid": [
        "42DEFB78-54D1-46BD-A267-DB6405E121D6",
        "7E9C137E-5C64-41C5-A22A-C91F98CE1C9F",
        "ED0F59B9-67E8-4422-9B97-F03636A0C4E9"
    ],
    "startDate": "5/16/2018",
    "endDate": "5/18/2018"
}

Notes

If no parameters were specified ProducerId considers as a default parameter.
An API request can contain both StartDate and EndDate or StartDate only, as follows:

If a request is sent with only StartDate, then the status will be returned for all invoices that changed since that date.
If a request is sent both a StartDate and EndDate, then the status will be returned for all invoices that changed between those two dates.

RESPONSE

The response includes an HTTP status code, a set of response headers and a response body, which contains an array of status objects.

Status Codes

A successful operation returns status code 200 (OK).

Status code	Description
200 OK	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.
403 FORBIDDEN	The requestor is not authorized to view the response.
406 NOT ACCEPTABLE	Provided Accept HTTP Header is not supported.
415 UNSUPPORTED MEDIA TYPE	Provided Content-Type 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:

{
    "Statuses": [
        {
            "SubmissionId": "059ca6af-0464-490e-98b9-7b106608dee3",
            "InvoiceId": "4323",
            "PayorOrgId": "111",
            "PayorOrgEBillingId": "222",
            "Status": "received",
            "StatusNote": null,
            "StatusDate": "2018-07-07T23:32:57Z"
        },
        {
            "SubmissionId": "059ca6af-0464-490e-98b9-7b106608dee3",
            "InvoiceId": "4323",
            "PayorOrgId": "222",
            "PayorOrgEBillingId": "444",
            "Status": "received",
            "StatusNote": null,
            "StatusDate": "2018-07-07T23:32:57Z"
        }
    ]
}

An error occurred while processing a request:

{
"Message": "An unexpected error occurred. Please, contact the support team."
}