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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @ValidateRequest(Validator="IsAuthenticated")
    public static class RefundBookingPayment implements ICompany
    {
        /**
        * 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.")
        public UUID CompanyId = null;

        /**
        * The booking id
        */
        @ApiMember(Description="The booking id", IsRequired=true, ParameterType="path")
        public Integer Id = null;

        /**
        * The booking payment log id
        */
        @ApiMember(Description="The booking payment log id", IsRequired=true, ParameterType="path")
        public Integer PaymentLogId = null;

        /**
        * The amount to refund on the checkout.
        */
        @ApiMember(Description="The amount to refund on the checkout.", IsRequired=true)
        public Double Amount = null;

        /**
        * Any comments to be saved in log.
        */
        @ApiMember(Description="Any comments to be saved in log.")
        public String Comments = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public RefundBookingPayment setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Integer getId() { return Id; }
        public RefundBookingPayment setId(Integer value) { this.Id = value; return this; }
        public Integer getPaymentLogId() { return PaymentLogId; }
        public RefundBookingPayment setPaymentLogId(Integer value) { this.PaymentLogId = value; return this; }
        public Double getAmount() { return Amount; }
        public RefundBookingPayment setAmount(Double value) { this.Amount = value; return this; }
        public String getComments() { return Comments; }
        public RefundBookingPayment setComments(String value) { this.Comments = value; return this; }
    }

}

Java RefundBookingPayment DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
Content-Length: length

{}