Sensibill Rest API/com.getsensibill.rest.generated.v2.api/MerchantsApi/getMerchants

getMerchants

@GET(value = "merchants")
abstract suspend fun getMerchants(@Query(value = "name") name: String? = null): Response<MerchantsDto>

Merchants list This endpoint allows you to retrieve a list of merchants with a name, optional merchantID, and optional receipt category that corresponds to the merchant category. Limited to 20 and in ascending alphabetical order. This endpoint requires authentication. Both a user token or a client token are accepted. Requests using a user token will match against merchants available for all users and also against merchant names the user has used on their documents. Those merchants will only have a name, and no merchantID or category. Responses:

  • 200: Success. The list of merchants was retrieved and returned.

  • 500: Internal server error.

Return

MerchantsDto

Parameters

name

An optional name to perform a prefix search on. (optional)