BokaMera.API.Host

<back to all web services

CreateRebateCodeTransaction

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/rebatecodes/transactionsCreate transaction for the rebate codeCreate transaction for the rebate code
import Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class CreateRebateCodeTransaction : Codable
{
    /**
    * 
    */
    // @ApiMember(Description="", IsRequired=true)
    public var companyId:String?

    /**
    * Rebate code id to which you wish to add transaction
    */
    // @ApiMember(Description="Rebate code id to which you wish to add transaction", IsRequired=true)
    public var rebateCodeId:Int

    // @ApiMember(IsRequired=true)
    public var amount:Double

    // @ApiMember(IsRequired=true)
    public var usage:Int

    // @ApiMember()
    public var bookingId:Int?

    /**
    * If you want to Increase = 0 or Decrease = 1 the value
    */
    // @ApiMember(Description="If you want to Increase = 0 or Decrease = 1 the value", IsRequired=true)
    public var changeType:AmountChangeType

    required public init(){}
}

public enum AmountChangeType : String, Codable
{
    case Increase
    case Decrease
}

public class RebateCodeTransactionResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var rebateCodeTransactionItem:RebateCodeTransactionQueryResponse

    required public init(){}
}

public class RebateCodeTransactionQueryResponse : Codable
{
    public var id:Int
    public var companyId:String
    public var note:String
    public var rebateCodeId:Int
    public var rebateCodeSign:String
    public var rebateCodeTypeId:Int?
    public var rebateCodeTypeName:String
    public var amount:Double
    public var bookingId:Int?
    public var updatedDate:Date
    public var createdDate:Date
    public var service:RebateCodeServiceResponse
    public var customer:RebateCodeCustomerResponse
    public var priceSign:String

    required public init(){}
}

public class RebateCodeServiceResponse : Codable
{
    public var id:Int
    public var name:String
    public var Description:String
    public var active:Bool

    required public init(){}
}

public class RebateCodeCustomerResponse : Codable
{
    public var id:String
    public var firstname:String
    public var lastname:String
    public var email:String
    public var phone:String
    public var imageUrl:String

    required public init(){}
}


Swift CreateRebateCodeTransaction 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.

POST /rebatecodes/transactions HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","RebateCodeId":0,"Amount":0,"Usage":0,"BookingId":0,"ChangeType":"Increase"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"RebateCodeTransactionItem":{"Id":0,"Note":"String","RebateCodeId":0,"RebateCodeSign":"String","RebateCodeTypeId":0,"RebateCodeTypeName":"String","Amount":0,"BookingId":0,"Service":{"Id":0,"Name":"String","Description":"String","Active":false},"Customer":{"Firstname":"String","Lastname":"String","Email":"String","Phone":"String","ImageUrl":"String"},"PriceSign":"String"}}