Get onboarding job status
Changed onUsed for polling purposes, to collect the job status of an ongoing company or individual creation request. Returns the location of the resource or a list of errors, depending on the outcome of the operation.
Request
- Base URLhttps://api-demo.fonoa.com
- URLhttps://api-demo.fonoa.com/onboarding/v2/jobs/{id}
- AuthAPI key in header Ocp-Apim-Subscription-Key
Path parameters
The identifier for the job.
Response
Successful job response
Example response
{
"status": "success",
"data": {
"id": "fad3e91a0a46489cbcb82db1693df05b",
"location": "https://api-demo.fonoa.com/onboarding/v2/companies/fad3e91a0a46489cbcb82db1693df05b"
},
"message": "The company was successfully onboarded"
}Changes
- breaking
the response property
became nullable for the status - breaking
the response property
became nullable for the status - warning
removed the optional property
//from the response with the status - warning
removed the optional property
//from the response with the status - warning
removed the optional property
//from the response with the status - warning
added the new
failedenum value to theresponse property for the response status - warning
added the new
in-progressenum value to theresponse property for the response status - warning
added the new
successenum value to theresponse property for the response status - info
api operation id
getOnboardingJobStatuswas added - info
api tag
E-Invoicing Endpointsadded - info
removed the non-success response with the status
- info
removed the non-success response with the status
- info
removed the non-success response with the status
- info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
removed from the
response propertyallOflist for the response status - info
the
response's property default valueThe company was successfully onboardedwas added for the status - info
the
response's property default valuesuccesswas added for the status
- breaking