The Status REST API is designed to expose the capability to check the status of invoice submissions.

Search Invoice Status
- Request
- Response
Get Invoice Details
- Request
  - URI Parameters
  - Request Headers
- Response
Get Status History of the Invoice
- Request
  - URI Parameters
  - Request Headers
- Response
Update Status of the Invoice
- Request
- Response

Search Invoice Status

The operation returns invoices statuses by specified search parameters.

Request

Method	Request URI	HTTP Version
POST	{eBHDomain}/statuses/api/v1/search	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."
}

Get Details of the Invoices

The operation retrieves a list of invoice details.

Request

Method	Request URI	HTTP Version
GET	{eBHDomain}/statuses/api/v2/details	HTTP/1.1

URI Parameters

The following table describes required and optional URI parameters.

Parameter	Description
InvoiceId	Required. Billing organization’s assigned invoice numbers or codes for which to obtain status.

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

Response

The response includes an HTTP status code, a set of response headers and a response body, which contains a list of invoice details.

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.
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:

The response represents an array of objects.

{
    "InvoiceList": {
        "ListOfInvoices": [
            {
                "InvoiceId": "111111",
                "HubReferenceNumber": 1111,
                "InvoiceDate": "1/01/2020",
                "StartDate": "5/15/2020",
                "EndDate": "5/15/2020",
                "TransmitDateTime": "",
                "ApprovedDateTime": "",
                "CurrentHubStatus": "RECEIVED",
                "ChangeDateTime": "9/28/2021 11:43:24 AM",
                "MatterId": "11111.11",
                "MatterDescription": "CORPORATION",
                "StatusNote": "",
                "EBHRecipient": "TEST USER",
                "PayorOrgEBillingId": 1234,
                "TrackingNumber": "",
                "Vendor": "LEGAL TRACKER API TEST",
                "ClientName": "TEST CLIENT",
                "ClientId": "0123",
                "InvoicePrefixPostfix": "PRE111111POST"
            }
        ],
        "Count": 1
    }
}‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

An error occurred while processing a request:

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

Get Status History of the Invoice

The operation retrieves an invoice status history.

Request

Method	Request URI	HTTP Version
GET	{eBHDomain}/statuses/api/v1/history	HTTP/1.1

URI Parameters

The following table describes required and optional URI parameters.

Parameter	Description
SubmissionId	Required (either 'SubmissionId' or 'InvoiceId' should be specified). The id returned in the response from Submission API POST request for which to obtain status.
InvoiceId	Required (either 'SubmissionId' or 'InvoiceId' should be specified). Billing organization’s assigned invoice number or code for which to obtain status.

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

Response

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

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.
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:

The response represents an array of objects.

{
    "InvoiceStatuses": [
        {
            "SubmissionId": "059ca6af-0464-490e-98b9-7b106608dee3",
            "InvoiceId": "4326",
            "PayorOrgId": "111",
            "PayorOrgEBillingId": "222",
            "StatusHistory": [
                {
                    "Status": "received",
                    "StatusDate": "2018-07-07T23:32:57"
                },
                {
                    "Status": "ebilled",
                    "StatusDate": "2018-07-20T23:32:57"
                }
            ]
        },
        {
            "SubmissionId": "059ca6af-0464-490e-98b9-7b106608dee3",
            "InvoiceId": "4326",
            "PayorOrgId": "222",
            "PayorOrgEBillingId": "444",
            "StatusHistory": [
                {
                    "Status": "received",
                    "StatusDate": "2018-07-07T23:32:57"
                },
                {
                    "Status": "ebilled",
                    "StatusDate": "2018-07-22T23:32:57"
                }
            ]
        }
    ]
}

An error occurred while processing a request:

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

Update Status of the Invoice

The operation updates the status of the invoice.

Request

Method	Request URI	HTTP Version
PUT	{eBHDomain}/statuses/api/v1/invoice	HTTP/1.1

URI Parameters

The following table describes required and optional URI parameters.

Parameter	Description
SubmissionId	Required (either 'SubmissionId' or 'InvoiceId' should be specified). The id returned in the response from Submission API POST request for which to obtain status.
InvoiceId	Required (either 'SubmissionId' or 'InvoiceId' should be specified). Billing organization’s assigned invoice number or code for which to obtain status.
PayorOrgId	Required (either 'PayorOrgId' or 'PayorOrgEBillingId' or both should be specified). Billing organization’s assigned payor organization identifier. Multiple values allowed.
PayorOrgEBillingId	Required (either 'PayorOrgId' or 'PayorOrgEBillingId' or both should be specified). Billing organization’s assigned payor organization ebilling identifier. Multiple values allowed.

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
Status	Required. Specifies a value for updating an invoice status.
Comment	Required. Specifies a comment providing free text detail about the status update.

{
    "Status": "hold",
    "Comment": "message"
}

Response

The response includes an HTTP status code, a set of response headers and a response body.

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:

Empty.

An error occurred while processing a request:

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