|
Method |
Request URI |
HTTP Version |
|
PUT |
OLD URL (will be deprecated soon): {OLD EBH domain}/statuses/api/{api version}/invoice NEW URL (recommended): {NEW EBH domain}/ebh/statuses/{api version}/invoice Api versions: v1, v2. |
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"
}
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."
}