E-Invoicing Endpoints

Get onboarding job status

Changed on

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

get/onboarding/v2/jobs/{id}

Request

  • Base URL
    https://api-demo.fonoa.com
  • URL
    https://api-demo.fonoa.com/onboarding/v2/jobs/{id}
  • Auth
    API key in header Ocp-Apim-Subscription-Key

Path parameters

idstring required

The identifier for the job.

Response

Successful job response

status'success' | 'failed' | 'in-progress'

The status of the asynchronous job. Returns success when the operation has completed.

messagestring nullable

Message describing the status of the operation.

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 failed enum value to the response property for the response status

    • warning

      added the new in-progress enum value to the response property for the response status

    • warning

      added the new success enum value to the response property for the response status

    • info

      api operation id getOnboardingJobStatus was added

    • info

      api tag E-Invoicing Endpoints added

    • 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 property allOf list for the response status

    • info

      the response's property default value The company was successfully onboarded was added for the status

    • info

      the response's property default value success was added for the status