BokaMera.API.Host

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.

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


// @ValidateRequest(Validator="IsAuthenticated")
class RefundBookingPayment implements ICompany, JsonSerializable
{
    public function __construct(
        /** @description The company id, if empty will use the company id for the user you are logged in with. */
        // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
        /** @var string|null */
        public ?string $CompanyId=null,

        /** @description The booking id */
        // @ApiMember(Description="The booking id", IsRequired=true, ParameterType="path")
        /** @var int */
        public int $Id=0,

        /** @description The booking payment log id */
        // @ApiMember(Description="The booking payment log id", IsRequired=true, ParameterType="path")
        /** @var int */
        public int $PaymentLogId=0,

        /** @description The amount to refund on the checkout. */
        // @ApiMember(Description="The amount to refund on the checkout.", IsRequired=true)
        /** @var float */
        public float $Amount=0.0,

        /** @description Any comments to be saved in log. */
        // @ApiMember(Description="Any comments to be saved in log.")
        /** @var string|null */
        public ?string $Comments=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['PaymentLogId'])) $this->PaymentLogId = $o['PaymentLogId'];
        if (isset($o['Amount'])) $this->Amount = $o['Amount'];
        if (isset($o['Comments'])) $this->Comments = $o['Comments'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->PaymentLogId)) $o['PaymentLogId'] = $this->PaymentLogId;
        if (isset($this->Amount)) $o['Amount'] = $this->Amount;
        if (isset($this->Comments)) $o['Comments'] = $this->Comments;
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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

{}