BokaMera.API.Host

<back to all web services

RefundBookingPayment

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/bookings/{Id}/refund/{PaymentLogId}Refund a payment on a booking.
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RefundBookingPayment(ICompany):
    # @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    company_id: Optional[str] = None
    """
    The company id, if empty will use the company id for the user you are logged in with.
    """


    # @ApiMember(Description="The booking id", IsRequired=true, ParameterType="path")
    id: int = 0
    """
    The booking id
    """


    # @ApiMember(Description="The booking payment log id", IsRequired=true, ParameterType="path")
    payment_log_id: int = 0
    """
    The booking payment log id
    """


    # @ApiMember(Description="The amount to refund on the checkout.", IsRequired=true)
    amount: float = 0.0
    """
    The amount to refund on the checkout.
    """


    # @ApiMember(Description="Any comments to be saved in log.")
    comments: Optional[str] = None
    """
    Any comments to be saved in log.
    """

Python RefundBookingPayment DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /bookings/{Id}/refund/{PaymentLogId} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":0,"PaymentLogId":0,"Amount":0,"Comments":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{}