Sensibill Rest API/com.getsensibill.rest.generated.v2.api/ExportsApi

ExportsApi

interface ExportsApi

Functions

Link copied to clipboard
@POST(value = "exports")
abstract suspend fun createExport(@Body exportCreateDto: ExportCreateDto): Response<ExportCreateResponseDto>

Export documents This API call allows you to export a set of documents for a user. To call this endpoint, you must use a user-token. You can not call this endpoint without it. \\ Users can have as many exports as they need. Exports are kept in Sensibill's system for the period of 14 days. Responses:

Link copied to clipboard
@GET(value = "exports/{id}")
abstract suspend fun getExportById(@Path(value = "id") id: String): Response<ExportsResponseDto>

Get export status This endpoint provides the ability to periodically poll for the export status. The id is the export id received during the first step (asynchronous POST). \\ The response contains status information on the export. Responses:

Link copied to clipboard
@GET(value = "exports")
abstract suspend fun getExports(): Response<List<ExportsResponseDto>>

Get exports This endpoint provides the ability to retrieve the list of exports for a user. A user-token is required to access this endpoint. Responses: