| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| 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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<RefundBookingPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Amount>0</Amount>
<Comments>String</Comments>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Id>0</Id>
<PaymentLogId>0</PaymentLogId>
</RefundBookingPayment>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />