Changelog

All notable changes to OpenAPI will be documented in this file.

[1.4.17] - 2024-11-13

Added

• Added new field priceDetails to all customer contract related endpoints (See e.g. response of Get customer contracts by endpoint)

[1.4.16] - 2024-10-09

Added

• Added new parameter barcode and mark the old parameter qrCodeUuid as deprecated:
  • Get customer by from all relevant studios
  • Get customer by
  • Get customer's measurement
  • Get customer contracts by

[1.4.15] - 2024-10-02

Added

• Introducing new cross studio features:
  • Get customer's checkin history from all relevant studios
• Added new studioId and studioName field to the response CustomerCheckin of endpoint Get customer's checkin history
• Introducing new Customers Communication features:
  • Create communication thread
  • Update communication thread

    ---

[1.4.14] - 2024-09-04

Added

• Introducing new cross studio features:
  • Get customer by id from all relevant studios
  • Get customer by from all relevant studios
  • Search customers in all relevant studios
• Added new studioId field to the response Customers endpoints (See e.g. response of Get customer by id endpoint)

[1.4.13] - 2024-08-15

Changed

• Added participantStatus and classSlotStatus properties to all endpoints returning class slot booking result (See e.g. Get booking by id )
• Added participantStatus and appointmentStatus properties to all endpoints returning appointment booking result (See e.g. Get appointment booking by booking id )
• Added countryOfBirth property to the response of Get customer's master data and the request and response of Create master data amendment endpoints

[1.4.12] - 2024-08-07

Added

• new Customers features
  • Get customer access code
  • Added new accessCodeConfiguration field to the response of Get studio general information endpoint
• Introducing new trial offer booking features:
  • Get bookable trial offer classes
  • Get bookable trial offer appointments
  • Get trial offer config
  • Validate for lead customer creation
  • Create a lead customer
  • Get class slots for trial offers
  • Get bookable appointment slots for trial offers
  • Validate class slot is bookable for trial offer
  • Validate for appointment booking for trial offers
  • Book a class slot for trial offers
  • Book an appointment for trial offers

[1.4.11] - 2024-07-24

Changed

• Extended classes use case description with stand-in functionality

  ---

  [1.4.10] - 2024-07-03

  Changed

• Added contractId and latestRejectionReason for each debt in response of Get debt collection cases
• Added origin to the response of Get Transfer Details

[1.4.9] - 2024-05-15

Changed

• Added required to all fields of Create payment data amendment to match actual implementation
• Added classId in the payload of webhook event type CLASS_SLOT_UPDATED and CLASS_SLOT_CANCELLED

[1.4.8] - 2024-05-08

Added

• Added use case description for additional modules
• Added new webhook event type CLASS_SLOT_UPDATED (triggered on resource updates)
• Added new endpoint Get class bookings by customer id to retrieve all class bookings for a customerId

Changed

• APPOINTMENT_BOOKING_UPDATED event is now also triggered on resource updates

[1.4.7] - 2024-04-03

Added

• Added new createdDate property to contractDetails in:
  • Get debtors response
• Added new publicName property to all endpoints returning instructors (See e.g. Get bookable appointment slots )
• Added new cancellationReceiptDate property to all endpoints returning contracts (See e.g. Get customer contracts by )
• Added new customerNumber query param to the endpoint Get customer by and Get customer contracts by
• Added the debt claims id to the response of Get customers account transaction history and Get customers account upcoming bookings endpoint

[1.4.6] - 2024-03-20

Added

• Added new preferredLanguage field to the response of Customers endpoints (See e.g. response of Get customer by id endpoint).
• Added new additionalParticipants field to the response of Get class slot by id endpoint

[1.4.5] - 2024-03-13

Added

• Added use case description for tax advisor
• Introducing new tax advisor accounting data features:
  • POST create tax advisor Export
  • GET get tax advisor Export
• general improvements to parameter documentations across multiple endpoints

[1.4.4] - 2024-03-06

Added

• Updated Data Chunking section
• Updated APPOINTMENT_BOOKING_UPDATE event
• Added use case description for classes and appointments
• Introducing new additional module purchasing features:
  • Get additional modules
  • Get purchasable additional modules
  • Validate an additional module contract request
  • Purchase an additional module contract
  • Get an additional module contract
  • Create additional module contract cancelation amendment
  • Withdraw cancelation of the additional module contract

[1.4.3] - 2024-01-24

Added

• Introducing required scopes in endpoint descriptions
• Introducing new closure reasons in Update transfer
  • HARD_NEGATIVES_IN_DEBTOR_REGISTER
  • POSTAL_DELIVERY_NOT_POSSIBLE
  • CLAIM_INCREASE_IMPORTED_CASE
• Introducing an optional free text closure reason in Update transfer
• reduce default slice sizes in Customers endpoints

[1.4.2] - 2023-11-02

Added

• Introducing customer's activity features:
  • Get customer's checkin history
• Adjustment of Get customer by endpoint
  • Added new optional query parameter debtorId
  • Added new optional query parameter qrCodeUuid
• Introducing Customers features:
  • Get customer contracts by

[1.4.1] - 2023-10-18

• Added new studioId field to the response of Get studio general information endpoint
• Added new query parameter slotWindowStartDate to the Get bookable appointment slots endpoint
• Added new webhook event type CONTRACT_CREATED

[1.4.0] - 2023-10-05

• Introducing new Device features:
  • Get devices
  • Activate device
• Added signedDocumentUrl to the response of Get customer's contracts endpoint
• Changed request parameters of Get customer's measurement endpoint:
  • cardNumber is now optional
  • new optional uuid parameter

[1.3.0] - 2023-09-06

• Added new rejectionReason property to the request of the Update transfer endpoint along with new closureType value REJECTION
• Added dunningLevel and inDebtCollection to the response of Get customers account balance data endpoint
• Added accessRefusal , uuid and referralCode to the response of following endpoints:
  • Get customers
  • Get customer by id
  • Get customer by
  • Search customers

[1.2.1] - 2023-08-09

Added

• Introducing idle period features:
  • Get idle period config
  • Validate idle period validation request
  • Get idle periods or idle period amendment
  • Create idle period or idle period amendment
  • Withdraw idle period or idle period amendment
• Added new status to TransferDetails in:
  • Get transfer details response
• Introducing new Finance features:
  • Confirm transfer
• Introducing new Customer Account features:
  • Get customers account balance data
  • Get customers account transaction history
  • Get customers account upcoming bookings

[1.1.1] - 2023-06-21

• Added multiple fields to the results of the following Bookable appointment and appointment booking endpoints:
  • Book appointment booking
  • Get appointment booking by booking id
  • Get appointment bookings by customer id

[1.1.0] - 2023-06-07

Added

• Introducing Bookable appointment and appointment booking features:
  • Get bookable appointments
  • Get bookable appointment by bookable appointment id
  • Get bookable appointment slots
  • Validate for appointment booking
  • Book appointment booking
  • Get appointment booking by booking id
  • Delete appointment booking by booking id
  • Get appointment bookings by customer id
• Introducing Membership self service features:
  • Get contract data by customer id
  • Create contract cancelation amendment
  • Get contract cancelation reason data
  • Withdraw contract cancelation
• Added new status property to contactDetails in:
  • Get debtors response
  • Get transfer details response
• Added new addressStatus property to addressData in:
  • Get debtors response
  • Get transfer details response

[1.0.19] - 2023-03-17

Added

• Introducing Webhook request body content property for additional event data

[1.0.18] - 2023-01-25

Added

• Introducing Payment self-service features:
  • Get customer's payment data
  • Create payment data amendment

[1.0.17] - 2023-01-18

Added

• Introducing new Get booking by id operation
• Bank account information added to customer response body
  • accountHolder
  • bankName
  • bic
  • iban

[1.0.16] - 2023-01-04

Changed

• Added Managing Activations page .
• Added amendmentConfigurationStatus field to endpoints response:
  • Get customer's contact data
  • Get customer's address data
  • Get customer's master data
• Added new section Rate limit in OpenAPI general information
• Added new http code in OpenApi error handling section
• Added new 429 response code to every OpenAPI endpoint

[1.0.15] - 2022-12-27

Changed

• Added customerStatus query parameter to Get customers endpoint:

[1.0.14] - 2022-11-28

Changed

• Added customerNumber field to endpoints response:
  • Get customers
  • Get customer by id
  • Get customer by
  • Search customers
• Added contract and subcontract cancellationDate field to Get customer's contracts response

[1.0.13] - 2022-10-21

Added

• Introducing new Finance features:
  • Get transfer details
  • Get debtors
  • Update transfer

[1.0.12] - 2022-10-13

Changed

• Added new fields to Get customer's contracts response

[1.0.11] - 2022-09-12

Added

• Get studio general information operation

[1.0.10] - 2022-09-07

Added

• Introducing new Classes features:
  • Book a class slot
  • Validate class slot is bookable
  • Cancel booking
• new idlePeriods property to customer response body

[1.0.9] - 2022-08-15

Changed

• Replaced Get customer by endpoint with new one

[1.0.8] - 2022-08-09

Added

• Introducing Customers self-service features:
  • Get customer's contact data
  • Create contact data amendment
  • Get customer's address data
  • Create address data amendment
  • Get customer's master data
  • Create master data amendment
  • Withdraw customer's amendment

[1.0.7] - 2022-08-03

Added

• Introducing new Customers features:
  • Search customers
  • Get customer's benefits by card number

[1.0.6] - 2022-07-07

Added

• Introducing Classes features:
  • Get classes
  • Get class by id
  • Get class slots
  • Get class slot by id
• Phone number properties added to customer response body:
  • phonePrivate
  • phonePrivateMobile
  • phoneBusiness
  • phoneBusinessMobile

[1.0.5] - 2022-06-29

Added

• Post customer's benefit usage operation
• benefitKey request parameter added to Save weighing results operation

Fixed

• a typo in customer operations error responses

[1.0.4] - 2022-06-16

Added

• Get customer's benefits operation
• dateOfBirth property for Get customer by id operation response

Changed

• Dates are now presented in ISODate format

[1.0.3] - 2022-05-24

Changed

• Updated response body for Get customer by id operation

[1.0.2] - 2022-05-12

Added

• Get studio utilization operation
• imageUrl property to customer operations responses - url expires after 15 minutes

[1.0.1] - 2022-03-11

Added

• New Customers features:
  • Get customer's measurement
  • Save weighing results

[1.0.0] - 2022-01-21

Added

• Initial OpenAPI release - Customers features:
  • Get customers
  • Get customer by id
  • Get customer by
  • Get customer's contracts