|
Method |
Request URI |
HTTP Version |
|
POST |
OLD URL (will be deprecated soon): {OLD EBH domain}/submissions/api/{api version}/SubmissionRequests NEW URL (recommended): {NEW EBH domain}/ebh/submissions/{api version}/SubmissionRequests Api versions: v1, v2. |
HTTP/1.1 |
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/json (default), */*. |
|
InvoiceType |
Optional. Specifies the type of submitting invoice. A list of valid values: ESF, UBF (default). |
|
InvoiceState |
Optional. Specifies the state of submitting invoice. A list of valid values: FinalInvoice (default), Proforma. |
XML payload in one of the following formats: ESF, UBF.
The response includes an HTTP status code, a set of response headers and a response body, which contains the identifier of the created submission request.
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. |
|
406 NOT ACCEPTABLE |
Provided Accept HTTP Header is not supported. |
|
413 PAYLOAD TOO LARGE |
Too large payload size. |
|
415 UNSUPPORTED MEDIA TYPE |
Provided Content-Type HTTP Header is not supported. |
|
500 INTERNAL SERVER ERROR |
Something went wrong. |
|
Response header |
Description |
|
Location |
The location header indicates the URL to the created resource. |
|
OperationId |
The unique identifier associated with the request. |
A request was successfully processed:
The identifier of the created submission request returned.
{
"Id": "68e222bc-23d2-4417-b24c-3a0f63206863",
"PostTime": "2019-01-09T09:18:18.7367442Z",
"Invoices": [
{
"Id": "21355",
"PayorOrgId": "000015",
"PayorOrgEbillingId": 4388,
"Attachments": []
}
]
}
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"
]
}
}