Changelog
All notable changes to OpenAPI will be documented in this file.
[1.4.15] - 2024-10-02
Added
-
Introducing new
cross studio
features: -
Added new
studioId
andstudioName
field to the responseCustomerCheckin
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: -
Added new
studioId
field to the responseCustomers
endpoints (See e.g. response of Get customer by id endpoint)
[1.4.13] - 2024-08-15
Changed
-
Added
participantStatus
andclassSlotStatus
properties to all endpoints returning class slot booking result (See e.g. Get booking by id ) -
Added
participantStatus
andappointmentStatus
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
andlatestRejectionReason
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 typeCLASS_SLOT_UPDATED
andCLASS_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 tocontractDetails
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 ofCustomers
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: - 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:
[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
inCustomers
endpoints
[1.4.2] - 2023-11-02
Added
-
Introducing
customer's activity
features: -
Adjustment of
Get customer by
endpoint
-
Added new optional query parameter
debtorId
-
Added new optional query parameter
qrCodeUuid
-
Added new optional query parameter
-
Introducing
Customers
features:
[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: -
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 newclosureType
valueREJECTION
-
Added
dunningLevel
andinDebtCollection
to the response of Get customers account balance data endpoint -
Added
accessRefusal
,uuid
andreferralCode
to the response of following endpoints:
[1.2.1] - 2023-08-09
Added
-
Introducing
idle period
features: -
Added new
status
toTransferDetails
in:- Get transfer details response
-
Introducing new
Finance
features: -
Introducing new
Customer Account
features:
[1.1.1] - 2023-06-21
-
Added multiple fields to the results of the following
Bookable appointment and appointment booking
endpoints:
[1.1.0] - 2023-06-07
Added
-
Introducing
Bookable appointment and appointment booking
features: -
Introducing
Membership self service
features: -
Added new
status
property tocontactDetails
in:- Get debtors response
- Get transfer details response
-
Added new
addressStatus
property toaddressData
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:
[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: -
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: -
Added contract and subcontract
cancellationDate
field to Get customer's contracts response
[1.0.13] - 2022-10-21
Added
-
Introducing new
Finance
features:
[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: -
new
idlePeriods
property tocustomer
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:
[1.0.7] - 2022-08-03
Added
-
Introducing new
Customers
features:
[1.0.6] - 2022-07-07
Added
-
Introducing
Classes
features: -
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:
[1.0.0] - 2022-01-21
Added
-
Initial OpenAPI release -
Customers
features: