|
Method |
Request URI |
HTTP Version |
|
PUT |
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 URI parameters.
|
Parameter |
Description |
|
SubmissionId |
Required. A submitted request identifier returned in the response from Submission API POST request (root id). |
|
Id |
Required. A submitted invoice identifier returned in the response from Submission API POST request (nested invoice id) |
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), */*. |
Empty.
The response includes an HTTP status code, a set of response headers and a response body, which contains the identifier of the created association.
A successful operation returns status code 204 (No content).
|
Status code |
Description |
|
204 NO CONTENT |
The request was successful. |
|
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 |
A submission request or invoice was not found. |
|
406 NOT ACCEPTABLE |
Provided Accept HTTP Header is not supported. |
|
409 CONFLICT |
A submitted invoice was already sent to a vendor. |
|
415 UNSUPPORTED MEDIA TYPE |
Provided Content-Type HTTP Header is not supported. |
|
500 INTERNAL SERVER ERROR |
Something went wrong. |
|
Response header |
Description |
|
OperationId |
The unique identifier associated with the request. |
A request was successfully processed:
Empty.
An error occurred while processing a request:
{
"Message": "An unexpected error occurred. Please, contact the support team.
}