getDocumentsStatus

@GET(value = documents/status)
abstract suspend fun getDocumentsStatus(@Query(value = id) id: @JvmSuppressWildcards() List<String>, @Query(value = timeout) timeout: Int? = null): Response<DocumentsStatusResponseDto>
Content copied to clipboard

Query documents for processing status updates Query a list of documents (using their id) for their processing status Responses:

  • 200: Success. The list of document statuses was successfully retrieved.

  • 400: Bad Request. This will occur if you omit a required parameter, send an invalid parameter or if you provide an invalid value for a parameter.

  • 401: Unauthorized. This will occur if you do not supply an access-token to this endpoint, or if you provide an expired or invalid access token.

  • 403: Forbidden. This will occur if you try to use this endpoint without being setup for documents.

  • 500: Internal Server Error.

Return

DocumentsStatusResponseDto

Parameters

id

The unique identifier for the document in the Sensibill system. \\ You can query up to ten Ids at once by appending each pair with the &#x60;&amp;&#x60; character * @param timeout The most amount of time (in seconds) that the client wants to wait for a response from the server. \\ A response is immediately returned if timeout is omitted, but its value cannot be more than 25 seconds (max timeout) if provided. (optional)