@@ -20,8 +20,8 @@ |
||
20 | 20 | public function allowed(): array |
21 | 21 | { |
22 | 22 | return [ |
23 | - 'id' => 'string', // [read-only], |
|
24 | - 'name' => 'string', // [read-only], |
|
23 | + 'id' => 'string', // [read-only], |
|
24 | + 'name' => 'string', // [read-only], |
|
25 | 25 | ]; |
26 | 26 | } |
27 | 27 | } |
@@ -22,8 +22,8 @@ |
||
22 | 22 | return [ |
23 | 23 | 'choiceFields' => 'Array[ChoiceCustomField]', // A list of choice custom fields. The property is not present if there are no choice fields [read-only], |
24 | 24 | 'numberFields' => 'Array[NumberCustomField]', // A list of number custom fields. The property is not present if there are no number fields [read-only], |
25 | - 'onOffFields' => 'Array[OnOffCustomField]', // A list of on/off custom fields. The property is not present if there are no on/off fields [read-only], |
|
26 | - 'textFields' => 'Array[TextCustomField]', // A list of text custom fields. The property is not present if there are no text fields [read-only] |
|
25 | + 'onOffFields' => 'Array[OnOffCustomField]', // A list of on/off custom fields. The property is not present if there are no on/off fields [read-only], |
|
26 | + 'textFields' => 'Array[TextCustomField]', // A list of text custom fields. The property is not present if there are no text fields [read-only] |
|
27 | 27 | ]; |
28 | 28 | } |
29 | 29 | } |
@@ -20,13 +20,13 @@ |
||
20 | 20 | public function allowed(): array |
21 | 21 | { |
22 | 22 | return [ |
23 | - 'id' => 'string', // [read-only], |
|
24 | - 'price' => 'Price', // The total price for the booking [read-only], |
|
25 | - 'totalPayable' => 'Money', // The total amount payable now. This is the total gross price less any applicable credit [read-only], |
|
23 | + 'id' => 'string', // [read-only], |
|
24 | + 'price' => 'Price', // The total price for the booking [read-only], |
|
25 | + 'totalPayable' => 'Money', // The total amount payable now. This is the total gross price less any applicable credit [read-only], |
|
26 | 26 | 'expiration' => 'string:datetime', // The time at which this hold will expire [read-only], |
27 | - 'applicableMoneyCredit' => 'Money', // Existing customers can have a "store credit" that Bookeo uses automatically to pay for purchases. This field indicates the credit that would be applied to the booking if it was saved. This field is present only if the hold is being made on behalf of an existing customer. New customers cannot have pre-existing credit [read-only], |
|
28 | - 'applicableGiftVoucherCredit' => 'Money', // Indicates the credit resulting from money gift vouchers that would be applied to the booking if it was saved. This field is present only if some credit is applicable (from a gift voucher being redeemed at this time, or from previous unused gift vouchers if this booking is for an existing customer) [read-only], |
|
29 | - 'applicablePrepaidCredits' => 'integer', // Indicates the number of prepaid credits that would be applied to the booking if it was saved. Note that if prepaid credits are applicable, the total price would be reduced, and possibly be 0 if the credit can pay for the entire booking. This field is present only if the hold is being made on behalf of an existing customer. New customers cannot have pre-existing credit [read-only] |
|
27 | + 'applicableMoneyCredit' => 'Money', // Existing customers can have a "store credit" that Bookeo uses automatically to pay for purchases. This field indicates the credit that would be applied to the booking if it was saved. This field is present only if the hold is being made on behalf of an existing customer. New customers cannot have pre-existing credit [read-only], |
|
28 | + 'applicableGiftVoucherCredit' => 'Money', // Indicates the credit resulting from money gift vouchers that would be applied to the booking if it was saved. This field is present only if some credit is applicable (from a gift voucher being redeemed at this time, or from previous unused gift vouchers if this booking is for an existing customer) [read-only], |
|
29 | + 'applicablePrepaidCredits' => 'integer', // Indicates the number of prepaid credits that would be applied to the booking if it was saved. Note that if prepaid credits are applicable, the total price would be reduced, and possibly be 0 if the credit can pay for the entire booking. This field is present only if the hold is being made on behalf of an existing customer. New customers cannot have pre-existing credit [read-only] |
|
30 | 30 | ]; |
31 | 31 | } |
32 | 32 | } |
@@ -21,7 +21,7 @@ |
||
21 | 21 | { |
22 | 22 | return [ |
23 | 23 | 'info' => PaginationInfo::class, // [read-only] |
24 | - 'data' => 'array[Product]', // [read-only] |
|
24 | + 'data' => 'array[Product]', // [read-only] |
|
25 | 25 | ]; |
26 | 26 | } |
27 | 27 | } |
@@ -17,16 +17,16 @@ |
||
17 | 17 | 'id' => 'string', |
18 | 18 | 'creationTime' => 'string:datetime', // When this record was created |
19 | 19 | 'receivedTime' => 'string:datetime', // When this payment was received |
20 | - 'reason' => 'string', // Reason for the payment. Shown to customer where appropriate. Ex. "Deposit", "Balance payment", "Additional fee", etc, |
|
21 | - 'description' => 'string', // Indicates what the payment was for (ex. "Booking 1234", "Prepaid package ABC", "Gift voucher XYZ") |
|
22 | - 'comment' => 'string', // An optional comment tracked with the payment. Not shown to customers. |
|
23 | - 'amount' => Money::class, // The payment amount |
|
24 | - 'paymentMethod' => 'string', // ['creditCard' or 'paypal' or 'bankTransfer' or 'cash' or 'checque' or 'debitCard' or 'existingCredit' or 'accountCredit' or 'moneyVoucher' or 'other'] |
|
25 | - 'paymentMethodOther' => 'string', // If paymentMethod is 'other', this field is required, and it specifies what other method was used, |
|
26 | - 'agent' => 'string', // Who registered this payment. If this field is not present, it means that the customer paid online on Bookeo's booking page |
|
27 | - 'customerId' => 'string', // The id of customer associated with this payment |
|
28 | - 'gatewayName' => 'string', // The name of the payment gateway that processed the payment (if it was processed by a payment gateway) |
|
29 | - 'transactionId' => 'string', // The transaction number/id as provided by the payment gateway that processed the payment - if any |
|
20 | + 'reason' => 'string', // Reason for the payment. Shown to customer where appropriate. Ex. "Deposit", "Balance payment", "Additional fee", etc, |
|
21 | + 'description' => 'string', // Indicates what the payment was for (ex. "Booking 1234", "Prepaid package ABC", "Gift voucher XYZ") |
|
22 | + 'comment' => 'string', // An optional comment tracked with the payment. Not shown to customers. |
|
23 | + 'amount' => Money::class, // The payment amount |
|
24 | + 'paymentMethod' => 'string', // ['creditCard' or 'paypal' or 'bankTransfer' or 'cash' or 'checque' or 'debitCard' or 'existingCredit' or 'accountCredit' or 'moneyVoucher' or 'other'] |
|
25 | + 'paymentMethodOther' => 'string', // If paymentMethod is 'other', this field is required, and it specifies what other method was used, |
|
26 | + 'agent' => 'string', // Who registered this payment. If this field is not present, it means that the customer paid online on Bookeo's booking page |
|
27 | + 'customerId' => 'string', // The id of customer associated with this payment |
|
28 | + 'gatewayName' => 'string', // The name of the payment gateway that processed the payment (if it was processed by a payment gateway) |
|
29 | + 'transactionId' => 'string', // The transaction number/id as provided by the payment gateway that processed the payment - if any |
|
30 | 30 | ]; |
31 | 31 | } |
32 | 32 | } |
@@ -20,15 +20,15 @@ |
||
20 | 20 | public function allowed(): array |
21 | 21 | { |
22 | 22 | return [ |
23 | - 'id' => 'string', // The unique id for this business(Bookeo account) [read - only], |
|
24 | - 'name' => 'string', // [read - only], |
|
25 | - 'legalIdentifiers' => 'string, optional', // Tax ID, Vat ID, other legal identifiers [read - only], |
|
23 | + 'id' => 'string', // The unique id for this business(Bookeo account) [read - only], |
|
24 | + 'name' => 'string', // [read - only], |
|
25 | + 'legalIdentifiers' => 'string, optional', // Tax ID, Vat ID, other legal identifiers [read - only], |
|
26 | 26 | 'phoneNumbers' => 'Array[PhoneNumber]', // [read - only], |
27 | - 'websiteURL' => 'string, optional', // [read - only], |
|
28 | - 'emailAddress' => 'string, optional', // [read - only], |
|
29 | - 'streetAddress' => 'StreetAddress', // [read - only], |
|
30 | - 'logo' => 'Image, optional', // [read - only], |
|
31 | - 'description' => 'string, optional', // A description of the business, provided by the business itself . The content is in HTML . [read - only] |
|
27 | + 'websiteURL' => 'string, optional', // [read - only], |
|
28 | + 'emailAddress' => 'string, optional', // [read - only], |
|
29 | + 'streetAddress' => 'StreetAddress', // [read - only], |
|
30 | + 'logo' => 'Image, optional', // [read - only], |
|
31 | + 'description' => 'string, optional', // A description of the business, provided by the business itself . The content is in HTML . [read - only] |
|
32 | 32 | ]; |
33 | 33 | } |
34 | 34 | } |
35 | 35 | \ No newline at end of file |
@@ -20,8 +20,8 @@ |
||
20 | 20 | public function allowed(): array |
21 | 21 | { |
22 | 22 | return [ |
23 | - 'tag' => 'string', // [read-only], |
|
24 | - 'name' => 'string', // [read-only], |
|
23 | + 'tag' => 'string', // [read-only], |
|
24 | + 'name' => 'string', // [read-only], |
|
25 | 25 | 'customersDefault' => 'boolean', // [read-only] |
26 | 26 | ]; |
27 | 27 | } |
@@ -20,38 +20,38 @@ |
||
20 | 20 | public function allowed(): array |
21 | 21 | { |
22 | 22 | return [ |
23 | - 'bookingNumber' => 'string', // The unique booking number. Always treat as string [read-only], |
|
24 | - 'eventId' => 'string', // When the booking is for a product of type fixed or fixedCourse, this is the id of the slot (see /availability/slots). Note that for fixedCourse, Bookeo always returns the eventId of the first class in a course, even if the customer is enrolled starting from a later class. In this case, firstCourseEnrolledEvent will be set., |
|
25 | - 'firstCourseEnrolledEventId' => 'string', // If the product is of type fixedCourse, and it is possible to accept late enrolment, this is the id of the event (class) where the actual enrolment starts., |
|
26 | - 'dropinCourseEnrolledEventId' => 'string', // If the product is of type fixedCourse, and it is possible to accept bookings for a single class in the course (drop-in), this is the id of the event (class) actually enrolled in., |
|
27 | - 'startTime' => 'string:datetime', // The start time of the booking. When creating a booking, either this or eventId must be specified, |
|
28 | - 'endTime' => 'string:datetime', // The end time of the booking. When creating a new booking of type flexibleTime, you can specify this field to force an end time. Or you can omit this field, in which case Bookeo will calculate the end time based on product and options chosen., |
|
29 | - 'customerId' => 'string', // The id of the customer this booking is for. When creating a booking, use this to create a booking for an existing customer., |
|
30 | - 'customer' => 'Customer', // The customer associated with this booking When reading a booking, this field is included only if the parameter expandCustomer is set to true, and the application has the necessary read permission for the customer. An application can include this field only when creating a new booking for a new customer. To create a booking for an existing customer, use the customerId field instead, |
|
31 | - 'title' => 'string', // The title of this booking, same as the one displayed by Bookeo in the calendar [read-only], |
|
32 | - 'externalRef' => 'string', // An external reference number that identifies this booking in an external system. The maximum length is 64 characters., |
|
23 | + 'bookingNumber' => 'string', // The unique booking number. Always treat as string [read-only], |
|
24 | + 'eventId' => 'string', // When the booking is for a product of type fixed or fixedCourse, this is the id of the slot (see /availability/slots). Note that for fixedCourse, Bookeo always returns the eventId of the first class in a course, even if the customer is enrolled starting from a later class. In this case, firstCourseEnrolledEvent will be set., |
|
25 | + 'firstCourseEnrolledEventId' => 'string', // If the product is of type fixedCourse, and it is possible to accept late enrolment, this is the id of the event (class) where the actual enrolment starts., |
|
26 | + 'dropinCourseEnrolledEventId' => 'string', // If the product is of type fixedCourse, and it is possible to accept bookings for a single class in the course (drop-in), this is the id of the event (class) actually enrolled in., |
|
27 | + 'startTime' => 'string:datetime', // The start time of the booking. When creating a booking, either this or eventId must be specified, |
|
28 | + 'endTime' => 'string:datetime', // The end time of the booking. When creating a new booking of type flexibleTime, you can specify this field to force an end time. Or you can omit this field, in which case Bookeo will calculate the end time based on product and options chosen., |
|
29 | + 'customerId' => 'string', // The id of the customer this booking is for. When creating a booking, use this to create a booking for an existing customer., |
|
30 | + 'customer' => 'Customer', // The customer associated with this booking When reading a booking, this field is included only if the parameter expandCustomer is set to true, and the application has the necessary read permission for the customer. An application can include this field only when creating a new booking for a new customer. To create a booking for an existing customer, use the customerId field instead, |
|
31 | + 'title' => 'string', // The title of this booking, same as the one displayed by Bookeo in the calendar [read-only], |
|
32 | + 'externalRef' => 'string', // An external reference number that identifies this booking in an external system. The maximum length is 64 characters., |
|
33 | 33 | 'participants' => 'Array[Participant]', // Participants associated to this booking, |
34 | - 'resources' => 'Array[Resource]', // Resources involved in a booking, if the booking is for a product of type "flexibleTime". If the booking is for a different type of product, this field is empty/ignored. When creating or updating a booking, only the id of a resource is required. Any name passed is ignored. If not specified when creating or updating a booking, Bookeo will automatically assign available resources., |
|
35 | - 'canceled' => 'boolean', // Whether this booking is canceled [read-only], |
|
36 | - 'cancelationTime' => 'string:datetime', // If the booking is cancelled, this is the time when it was cancelled [read-only], |
|
37 | - 'cancelationAgent' => 'string', // If the booking is cancelled, this is the person who cancelled [read-only], |
|
38 | - 'accepted' => 'boolean', // Whether this booking was accepted. If no accept/deny was applicable to the booking, the booking is considered accepted as created. [read-only], |
|
39 | - 'sourceIp' => 'string', // The IP address from where this booking was created, |
|
40 | - 'creationTime' => 'string:datetime', // The time when the booking was created [read-only], |
|
41 | - 'creationAgent' => 'string', // The person that created the booking [read-only], |
|
42 | - 'lastChangeTime' => 'string:datetime', // The time when the booking was last updated. If the booking was never changed after creation, this field is not present. [read-only], |
|
43 | - 'lastChangeAgent' => 'string', // The person who last updated this booking. If the booking was never changed after creation, this field is not present. [read-only], |
|
44 | - 'productName' => 'string', // The name of the product this booking is for [read-only], |
|
45 | - 'productId' => 'string', // The id of the product this booking is for. For a full list of products and their ids, see /settings/products, |
|
46 | - 'price' => 'Price', // Details about price, taxes, etc. [read-only], |
|
34 | + 'resources' => 'Array[Resource]', // Resources involved in a booking, if the booking is for a product of type "flexibleTime". If the booking is for a different type of product, this field is empty/ignored. When creating or updating a booking, only the id of a resource is required. Any name passed is ignored. If not specified when creating or updating a booking, Bookeo will automatically assign available resources., |
|
35 | + 'canceled' => 'boolean', // Whether this booking is canceled [read-only], |
|
36 | + 'cancelationTime' => 'string:datetime', // If the booking is cancelled, this is the time when it was cancelled [read-only], |
|
37 | + 'cancelationAgent' => 'string', // If the booking is cancelled, this is the person who cancelled [read-only], |
|
38 | + 'accepted' => 'boolean', // Whether this booking was accepted. If no accept/deny was applicable to the booking, the booking is considered accepted as created. [read-only], |
|
39 | + 'sourceIp' => 'string', // The IP address from where this booking was created, |
|
40 | + 'creationTime' => 'string:datetime', // The time when the booking was created [read-only], |
|
41 | + 'creationAgent' => 'string', // The person that created the booking [read-only], |
|
42 | + 'lastChangeTime' => 'string:datetime', // The time when the booking was last updated. If the booking was never changed after creation, this field is not present. [read-only], |
|
43 | + 'lastChangeAgent' => 'string', // The person who last updated this booking. If the booking was never changed after creation, this field is not present. [read-only], |
|
44 | + 'productName' => 'string', // The name of the product this booking is for [read-only], |
|
45 | + 'productId' => 'string', // The id of the product this booking is for. For a full list of products and their ids, see /settings/products, |
|
46 | + 'price' => 'Price', // Details about price, taxes, etc. [read-only], |
|
47 | 47 | 'options' => 'Array[BookingOption]', |
48 | - 'privateEvent' => 'boolean', // Whether this booking reserves the entire event. Only available for products that allow it., |
|
49 | - 'promotionCodeInput' => 'string', // Optional promotion code input, can be used when creating or updating a booking It could be a single code, or a list of codes separated by comma (ex. multiple coupon/voucher codes) In general, applications creating bookings can simply ask the customer to input a promotion code (like they would on Bookeo's web interface) and pass the input in this field. Bookeo will then parse and validate any text entered, |
|
50 | - 'promotionName' => 'string', // The name of the promotion that was applied to this booking. [read-only], |
|
48 | + 'privateEvent' => 'boolean', // Whether this booking reserves the entire event. Only available for products that allow it., |
|
49 | + 'promotionCodeInput' => 'string', // Optional promotion code input, can be used when creating or updating a booking It could be a single code, or a list of codes separated by comma (ex. multiple coupon/voucher codes) In general, applications creating bookings can simply ask the customer to input a promotion code (like they would on Bookeo's web interface) and pass the input in this field. Bookeo will then parse and validate any text entered, |
|
50 | + 'promotionName' => 'string', // The name of the promotion that was applied to this booking. [read-only], |
|
51 | 51 | 'couponCodes' => 'string', |
52 | - 'giftVoucherCodeInput' => 'string', // A gift voucher code applicable to this booking. This field is only set by the application, when creating or updating a booking. It is possible to specify multiple codes, separated by commas. No more than one specific (as opposed to "generic", value-based) gift voucher can be used per booking., |
|
53 | - 'specificVoucherCode' => 'string', // When the booking used a service specific voucher (i.e. as opposed to a "generic" voucher, based on a fixed amount), the code of the voucher is reported here. [read-only], |
|
54 | - 'initialPayments' => 'Array[Payment]', // When creating a new booking, an application can also record one or more payment associated to the booking (ex. if the customer has paid a deposit or the full amount online) This field is never set by Bookeo, and is ignored unless this is a new booking being created. |
|
52 | + 'giftVoucherCodeInput' => 'string', // A gift voucher code applicable to this booking. This field is only set by the application, when creating or updating a booking. It is possible to specify multiple codes, separated by commas. No more than one specific (as opposed to "generic", value-based) gift voucher can be used per booking., |
|
53 | + 'specificVoucherCode' => 'string', // When the booking used a service specific voucher (i.e. as opposed to a "generic" voucher, based on a fixed amount), the code of the voucher is reported here. [read-only], |
|
54 | + 'initialPayments' => 'Array[Payment]', // When creating a new booking, an application can also record one or more payment associated to the booking (ex. if the customer has paid a deposit or the full amount online) This field is never set by Bookeo, and is ignored unless this is a new booking being created. |
|
55 | 55 | ]; |
56 | 56 | } |
57 | 57 | } |
@@ -41,7 +41,7 @@ |
||
41 | 41 | 'numCancelations' => 'integer', // Number of booking cancellations that were tracked for this customer |
42 | 42 | 'numNoShows' => 'integer', // Number of no-shows for this customer |
43 | 43 | 'member' => 'boolean', // Whether this customer is currently a member |
44 | - 'membershipEnd' => 'date', // When the membership expires. If the membership is not set to expire, this field is not set. |
|
44 | + 'membershipEnd' => 'date', // When the membership expires. If the membership is not set to expire, this field is not set. |
|
45 | 45 | ]; |
46 | 46 | } |
47 | 47 | } |