Lister les plafonds de remise par rôle de l'établissement

GET

/v1/establishments/{establishmentId}/discount-caps

const url = 'https://example.com/v1/establishments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/discount-caps?scope=discount';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/v1/establishments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/discount-caps?scope=discount' \
  --header 'X-API-Key: <X-API-Key>'

Retourne les plafonds configurés (une entrée par rôle). Un rôle absent = non plafonné configuré (fail-closed côté remise).

Authorizations

ApiKeyAuth
BearerAuth

Parameters

Path Parameters

establishmentId

required

string format: uuid

Query Parameters

scope

string

default: discount

Allowed values: discount derogation

Autorité plafonnée : remise folio (discount, défaut) ou dérogation résa (derogation).

Responses

200

application/json

object

data

required

object

caps

required

Array<object>

object

roleCode

required

string

maxPctBp

required

% max en basis points (1000 = 10 %)

integer

<= 10000

maxAmountCents

required

Montant TTC max remisé en centimes (bigint string)

string

Example

{
  "data": {
    "caps": [
      {
        "roleCode": "receptionist"
      }
    ]
  }
}