Get Supplement entities.

GETRequest

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

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

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

Responses

200400

Response 200

Successful response

application/json

Example responseGenerated from schema

[
  {
    "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
  }
]

Response 400

Bad request

application/json

Example 1

{
  "statusCode": 400,
  "description": "Bad request",
  "errors": [
    "Bad request"
  ]
}

Query parameters

• include[]string[]optional

  Additional (relational) data groups to include in the response

• descriptionstringoptional
• orderBystringoptional
• includedbooleanoptional
• deferredbooleanoptional
• requiredbooleanoptional
• guestbooleanoptional
• normalbooleanoptional
• packagebooleanoptional
• seasonalbooleanoptional
• yearbooleanoptional
• hasUnitOfMeasurementAdditionalGuestbooleanoptional
• hasUnitOfMeasurementUtilityConsumptionbooleanoptional
• hasUnitOfMeasurementPreviousUtilityConsumptionbooleanoptional
• hasUnitOfMeasurementDepositbooleanoptional
• hasPreferredUnitForGuestbooleanoptional
• hasCheckinTimebooleanoptional
• hasCheckoutTimebooleanoptional
• datestringoptional
• dateFromstringoptional
• dateTostringoptional
• relatedToCustomAccommodationUnitFeaturesbooleanoptional
• relatedToCustomPackageSpecificationsbooleanoptional
• settingsbooleanoptional
• ownerStatementSpecificationnumberoptional
• detailsbooleanoptional
• organizationnumberrequired
• accommodationnumberoptional
• accommodationCategorynumberoptional
• localityCategorynumberoptional
• packageSpecificationnumberoptional
• offsetnumberoptional
• limitnumberoptional
• reservationnumberoptional
• tokenstringoptional
• archivedbooleanoptional
• publicbooleanoptional

Returns

Array of Supplement

Schema shown for 200 · application/json

• idnumber
• typestringoptional
• descriptionstringoptional
• excerptstringoptional
• unitPricestringoptional
• percentagestringoptional
• hasUnitOfMeasurementDayboolean
• hasUnitOfMeasurementPersonboolean
• hasUnitOfMeasurementPetboolean
• hasUnitOfMeasurementAdditionalGuestboolean
• hasUnitOfMeasurementUtilityConsumptionboolean
• hasUnitOfMeasurementPreviousUtilityConsumptionboolean
• hasUnitOfMeasurementPercentageOfOrderLinesTotalboolean
• hasUnitOfMeasurementDepositboolean
• utilityConsumptionIncludedQuantitynumberoptional
• utilityConsumptionIncludedQuantityNumOfDaysFactorbooleanoptional
  Default: false
• utilityConsumptionTypestringoptional
• hasPreferredUnitForGuestboolean
• hasAnnualSettlementSpecificationboolean
• annualSettlementAdvancestringoptional
• eligibleMinNumOfDaysnumberoptional
• eligibleMaxNumOfDaysnumberoptional
• numOfDaysOffsetnumberoptional
• eligibleMinNumOfPersonsnumberoptional
• eligibleMaxNumOfPersonsnumberoptional
• eligibleMaxQuantitynumberoptional
• validFromstringoptional
• validThroughstringoptional
• validFromReservationDatestringoptional
• validThroughReservationDatestringoptional
• hasCheckinTimeboolean
• hasCheckoutTimeboolean
• checkinTimestringoptional
• checkoutTimestringoptional
• taxRatestringoptional
• positionnumberoptional
• valueAddedTaxIncludedboolean
• showOnUtilityMeterReportboolean
• requiredboolean
• publicboolean
• includedboolean
• deferredbooleanoptional
• guestboolean
• normalboolean
• packageboolean
• seasonalboolean
• yearboolean
• cancellationInsuranceboolean
• relatedToCustomAccommodationsboolean
• relatedToCustomAccommodationUnitFeaturesboolean
• relatedToCustomPackageSpecificationsboolean
• relatedToCustomAgeGroupSpecificationsboolean
• relatedToCustomPetSpecificationsboolean
• enabledForCancelledReservationsbooleanoptional
  Default: false
• inheritQuantityFromSupplementOfbooleanoptional
  Default: false
• reportbooleanoptional
• reportReferenceDatestringoptional
• reportTotalsbooleanoptional
• reportTotalsTypestringoptional
• activeboolean
• archivedstringoptional
• imagestringoptional
• localestring
• createdstringoptional
• modifiedstringoptional
• ageGroupSpecificationsobject[]
  Show array — 1 property

  • idnumberoptional
• petSpecificationsobject[]
  Show array — 1 property

  • idnumberoptional
• supplementOfobjectoptional
  Show 1 property

  • idnumberoptional
• categoryobjectoptional
  Show 1 property

  • idnumberoptional
• orderLinesTotalIncludesTaxboolean