> This page is optimized for agents. Use the linked Markdown pages and llms.txt indexes for related API content.

# Get QennerSupplement entities.

- Product: Qenner
- Section: Integration - Qenner
- Snapshot: Current
- Method: `GET`
- Path: `/api/qenner/supplements/`

## Query parameters

### `qennerAccommodation`

Type: `number`  
Required: yes  

## Execute with TypeScript

Package: `@recranet/sdk`  

```ts
import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.qenner.supplements.list({
  qennerAccommodation: 0,
});
```

## Execute with curl

```bash
curl "https://app.recranet.com/api/qenner/supplements/" \
    -H "X-Api-Key: $RECRANET_API_KEY" \
    --url-query "qennerAccommodation=$QENNERACCOMMODATION"
```

## Responses

### Response `200`

Category: success  

Successful response

#### `application/json`

##### Generated example

```json
[
  {
    "id": 0,
    "uniqueId": "uniqueId",
    "created": "created",
    "supplement": {
      "id": 0,
      "hasUnitOfMeasurementDay": true,
      "hasUnitOfMeasurementPerson": true,
      "hasUnitOfMeasurementPet": true,
      "hasUnitOfMeasurementAdditionalGuest": true,
      "hasUnitOfMeasurementUtilityConsumption": true,
      "hasUnitOfMeasurementPreviousUtilityConsumption": true,
      "hasUnitOfMeasurementPercentageOfOrderLinesTotal": true,
      "hasUnitOfMeasurementDeposit": true,
      "hasPreferredUnitForGuest": true,
      "hasAnnualSettlementSpecification": true,
      "hasCheckinTime": true,
      "hasCheckoutTime": true,
      "valueAddedTaxIncluded": true,
      "showOnUtilityMeterReport": true,
      "required": true,
      "public": true,
      "included": true,
      "guest": true,
      "normal": true,
      "package": true,
      "seasonal": true,
      "year": true,
      "cancellationInsurance": true,
      "relatedToCustomAccommodations": true,
      "relatedToCustomAccommodationUnitFeatures": true,
      "relatedToCustomPackageSpecifications": true,
      "relatedToCustomAgeGroupSpecifications": true,
      "relatedToCustomPetSpecifications": true,
      "active": true,
      "locale": "locale",
      "ageGroupSpecifications": [
        {
          "id": 1000
        }
      ],
      "petSpecifications": [
        {
          "id": 1000
        }
      ],
      "orderLinesTotalIncludesTax": true,
      "type": "type",
      "description": "description",
      "excerpt": "excerpt",
      "unitPrice": "unitPrice",
      "percentage": "percentage",
      "utilityConsumptionIncludedQuantity": 0,
      "utilityConsumptionIncludedQuantityNumOfDaysFactor": false,
      "utilityConsumptionType": "utilityConsumptionType",
      "annualSettlementAdvance": "annualSettlementAdvance",
      "eligibleMinNumOfDays": 0,
      "eligibleMaxNumOfDays": 0,
      "numOfDaysOffset": 0,
      "eligibleMinNumOfPersons": 0,
      "eligibleMaxNumOfPersons": 0,
      "eligibleMaxQuantity": 0,
      "validFrom": "validFrom",
      "validThrough": "validThrough",
      "validFromReservationDate": "validFromReservationDate",
      "validThroughReservationDate": "validThroughReservationDate",
      "checkinTime": "checkinTime",
      "checkoutTime": "checkoutTime",
      "taxRate": "taxRate",
      "position": 0,
      "deferred": true,
      "enabledForCancelledReservations": false,
      "inheritQuantityFromSupplementOf": false,
      "report": true,
      "reportReferenceDate": "reportReferenceDate",
      "reportTotals": true,
      "reportTotalsType": "reportTotalsType",
      "archived": "archived",
      "image": "image",
      "created": "created",
      "modified": "modified",
      "supplementOf": null,
      "category": null
    },
    "modified": "modified"
  }
]
```

##### Schema

###### QennerSupplement[]

Type: `QennerSupplement[]`  

###### QennerSupplement

Type: `QennerSupplement`  

###### `id`

Type: `number`  
Required: yes  

###### `uniqueId`

Type: `string`  
Required: yes  

###### `created`

Type: `string`  
Format: `date-time`  
Required: yes  

###### `modified`

Type: `string`  
Format: `date-time`  
Required: no  

###### `supplement`

Type: `Supplement`  
Required: yes  

###### `id`

Type: `number`  
Required: yes  

###### `type`

Type: `string`  
Required: no  

###### `description`

Type: `string`  
Required: no  

###### `excerpt`

Type: `string`  
Required: no  

###### `unitPrice`

Type: `string`  
Required: no  

###### `percentage`

Type: `string`  
Required: no  

###### `hasUnitOfMeasurementDay`

Type: `boolean`  
Required: yes  

###### `hasUnitOfMeasurementPerson`

Type: `boolean`  
Required: yes  

###### `hasUnitOfMeasurementPet`

Type: `boolean`  
Required: yes  

###### `hasUnitOfMeasurementAdditionalGuest`

Type: `boolean`  
Required: yes  

###### `hasUnitOfMeasurementUtilityConsumption`

Type: `boolean`  
Required: yes  

###### `hasUnitOfMeasurementPreviousUtilityConsumption`

Type: `boolean`  
Required: yes  

###### `hasUnitOfMeasurementPercentageOfOrderLinesTotal`

Type: `boolean`  
Required: yes  

###### `hasUnitOfMeasurementDeposit`

Type: `boolean`  
Required: yes  

###### `utilityConsumptionIncludedQuantity`

Type: `number`  
Required: no  

###### `utilityConsumptionIncludedQuantityNumOfDaysFactor`

Type: `boolean`  
Required: no  
Default: `false`  

###### `utilityConsumptionType`

Type: `string`  
Required: no  

###### `hasPreferredUnitForGuest`

Type: `boolean`  
Required: yes  

###### `hasAnnualSettlementSpecification`

Type: `boolean`  
Required: yes  

###### `annualSettlementAdvance`

Type: `string`  
Required: no  

###### `eligibleMinNumOfDays`

Type: `number`  
Required: no  

###### `eligibleMaxNumOfDays`

Type: `number`  
Required: no  

###### `numOfDaysOffset`

Type: `number`  
Required: no  

###### `eligibleMinNumOfPersons`

Type: `number`  
Required: no  

###### `eligibleMaxNumOfPersons`

Type: `number`  
Required: no  

###### `eligibleMaxQuantity`

Type: `number`  
Required: no  

###### `validFrom`

Type: `string`  
Format: `date-time`  
Required: no  

###### `validThrough`

Type: `string`  
Format: `date-time`  
Required: no  

###### `validFromReservationDate`

Type: `string`  
Format: `date-time`  
Required: no  

###### `validThroughReservationDate`

Type: `string`  
Format: `date-time`  
Required: no  

###### `hasCheckinTime`

Type: `boolean`  
Required: yes  

###### `hasCheckoutTime`

Type: `boolean`  
Required: yes  

###### `checkinTime`

Type: `string`  
Required: no  

###### `checkoutTime`

Type: `string`  
Required: no  

###### `taxRate`

Type: `string`  
Required: no  

###### `position`

Type: `number`  
Required: no  

###### `valueAddedTaxIncluded`

Type: `boolean`  
Required: yes  

###### `showOnUtilityMeterReport`

Type: `boolean`  
Required: yes  

###### `required`

Type: `boolean`  
Required: yes  

###### `public`

Type: `boolean`  
Required: yes  

###### `included`

Type: `boolean`  
Required: yes  

###### `deferred`

Type: `boolean`  
Required: no  

###### `guest`

Type: `boolean`  
Required: yes  

###### `normal`

Type: `boolean`  
Required: yes  

###### `package`

Type: `boolean`  
Required: yes  

###### `seasonal`

Type: `boolean`  
Required: yes  

###### `year`

Type: `boolean`  
Required: yes  

###### `cancellationInsurance`

Type: `boolean`  
Required: yes  

###### `relatedToCustomAccommodations`

Type: `boolean`  
Required: yes  

###### `relatedToCustomAccommodationUnitFeatures`

Type: `boolean`  
Required: yes  

###### `relatedToCustomPackageSpecifications`

Type: `boolean`  
Required: yes  

###### `relatedToCustomAgeGroupSpecifications`

Type: `boolean`  
Required: yes  

###### `relatedToCustomPetSpecifications`

Type: `boolean`  
Required: yes  

###### `enabledForCancelledReservations`

Type: `boolean`  
Required: no  
Default: `false`  

###### `inheritQuantityFromSupplementOf`

Type: `boolean`  
Required: no  
Default: `false`  

###### `report`

Type: `boolean`  
Required: no  

###### `reportReferenceDate`

Type: `string`  
Required: no  

###### `reportTotals`

Type: `boolean`  
Required: no  

###### `reportTotalsType`

Type: `string`  
Required: no  

###### `active`

Type: `boolean`  
Required: yes  

###### `archived`

Type: `string`  
Format: `date-time`  
Required: no  

###### `image`

Type: `string`  
Required: no  

###### `locale`

Type: `string`  
Required: yes  

###### `created`

Type: `string`  
Format: `date-time`  
Required: no  

###### `modified`

Type: `string`  
Format: `date-time`  
Required: no  

###### `ageGroupSpecifications`

Type: `object[]`  
Required: yes  

###### object

Type: `object`  

###### `id`

Type: `number`  
Required: no  

###### `petSpecifications`

Type: `object[]`  
Required: yes  

###### object

Type: `object`  

###### `id`

Type: `number`  
Required: no  

###### `supplementOf`

Type: `object`  
Required: no  

###### `id`

Type: `number`  
Required: no  

###### `category`

Type: `object`  
Required: no  

###### `id`

Type: `number`  
Required: no  

###### `orderLinesTotalIncludesTax`

Type: `boolean`  
Required: yes  

## Related representations

- [Human documentation](/qenner/supplements/methods/list/)
- [TypeScript Markdown](/qenner/supplements/methods/list.md?lang=typescript)
- [curl Markdown](/qenner/supplements/methods/list.md?lang=curl)
- [site llms.txt](/llms.txt)
- [product llms.txt](/qenner/llms.txt)
- [snapshot llms.txt](/qenner/llms.txt)