Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /bookings/{Id}/refund/{PaymentLogId} | Refund a payment on a booking. |
---|
"use strict";
export class RefundBookingPayment {
/** @param {{CompanyId?:string,Id?:number,PaymentLogId?:number,Amount?:number,Comments?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?string}
* @description The company id, if empty will use the company id for the user you are logged in with. */
CompanyId;
/**
* @type {number}
* @description The booking id */
Id;
/**
* @type {number}
* @description The booking payment log id */
PaymentLogId;
/**
* @type {number}
* @description The amount to refund on the checkout. */
Amount;
/**
* @type {string}
* @description Any comments to be saved in log. */
Comments;
}
JavaScript 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/" />