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
"use strict";
export class RebateCodeServiceResponse {
    /** @param {{Id?:number,Name?:string,Description?:string,Active?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {boolean} */
    Active;
}
export class RebateCodeCustomerResponse {
    /** @param {{Id?:string,Firstname?:string,Lastname?:string,Email?:string,Phone?:string,ImageUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Firstname;
    /** @type {string} */
    Lastname;
    /** @type {string} */
    Email;
    /** @type {string} */
    Phone;
    /** @type {string} */
    ImageUrl;
}
export class RebateCodeTransactionQueryResponse {
    /** @param {{Id?:number,CompanyId?:string,Note?:string,RebateCodeId?:number,RebateCodeSign?:string,RebateCodeTypeId?:number,RebateCodeTypeName?:string,Amount?:number,BookingId?:number,UpdatedDate?:string,CreatedDate?:string,Service?:RebateCodeServiceResponse,Customer?:RebateCodeCustomerResponse,PriceSign?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    CompanyId;
    /** @type {string} */
    Note;
    /** @type {number} */
    RebateCodeId;
    /** @type {string} */
    RebateCodeSign;
    /** @type {?number} */
    RebateCodeTypeId;
    /** @type {string} */
    RebateCodeTypeName;
    /** @type {number} */
    Amount;
    /** @type {?number} */
    BookingId;
    /** @type {string} */
    UpdatedDate;
    /** @type {string} */
    CreatedDate;
    /** @type {RebateCodeServiceResponse} */
    Service;
    /** @type {RebateCodeCustomerResponse} */
    Customer;
    /** @type {string} */
    PriceSign;
}
export class RebateCodeTransactionResponse {
    /** @param {{ResponseStatus?:ResponseStatus,RebateCodeTransactionItem?:RebateCodeTransactionQueryResponse}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {RebateCodeTransactionQueryResponse} */
    RebateCodeTransactionItem;
}
/** @typedef {'Increase'|'Decrease'} */
export var AmountChangeType;
(function (AmountChangeType) {
    AmountChangeType["Increase"] = "Increase"
    AmountChangeType["Decrease"] = "Decrease"
})(AmountChangeType || (AmountChangeType = {}));
export class CreateRebateCodeTransaction {
    /** @param {{CompanyId?:string,RebateCodeId?:number,Amount?:number,Usage?:number,BookingId?:number,ChangeType?:AmountChangeType}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CompanyId;
    /**
     * @type {number}
     * @description Rebate code id to which you wish to add transaction */
    RebateCodeId;
    /** @type {number} */
    Amount;
    /** @type {number} */
    Usage;
    /** @type {?number} */
    BookingId;
    /**
     * @type {AmountChangeType}
     * @description If you want to Increase = 0 or Decrease = 1 the value */
    ChangeType;
}

JavaScript CreateRebateCodeTransaction DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CreateRebateCodeTransaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Amount>0</Amount>
  <BookingId>0</BookingId>
  <ChangeType>Increase</ChangeType>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <RebateCodeId>0</RebateCodeId>
  <Usage>0</Usage>
</CreateRebateCodeTransaction>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RebateCodeTransactionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <RebateCodeTransactionItem>
    <Amount>0</Amount>
    <BookingId>0</BookingId>
    <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
    <CreatedDate>0001-01-01T00:00:00</CreatedDate>
    <Customer>
      <Email>String</Email>
      <Firstname>String</Firstname>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <ImageUrl>String</ImageUrl>
      <Lastname>String</Lastname>
      <Phone>String</Phone>
    </Customer>
    <Id>0</Id>
    <Note>String</Note>
    <PriceSign>String</PriceSign>
    <RebateCodeId>0</RebateCodeId>
    <RebateCodeSign>String</RebateCodeSign>
    <RebateCodeTypeId>0</RebateCodeTypeId>
    <RebateCodeTypeName>String</RebateCodeTypeName>
    <Service>
      <Active>false</Active>
      <Description>String</Description>
      <Id>0</Id>
      <Name>String</Name>
    </Service>
    <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
  </RebateCodeTransactionItem>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</RebateCodeTransactionResponse>