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

export class RebateCodeServiceResponse
{
    public Id: number;
    public Name: string;
    public Description: string;
    public Active: boolean;

    public constructor(init?: Partial<RebateCodeServiceResponse>) { (Object as any).assign(this, init); }
}

export class RebateCodeCustomerResponse
{
    public Id: string;
    public Firstname: string;
    public Lastname: string;
    public Email: string;
    public Phone: string;
    public ImageUrl: string;

    public constructor(init?: Partial<RebateCodeCustomerResponse>) { (Object as any).assign(this, init); }
}

export class RebateCodeTransactionQueryResponse
{
    public Id: number;
    public CompanyId: string;
    public Note: string;
    public RebateCodeId: number;
    public RebateCodeSign: string;
    public RebateCodeTypeId?: number;
    public RebateCodeTypeName: string;
    public Amount: number;
    public BookingId?: number;
    public UpdatedDate: string;
    public CreatedDate: string;
    public Service: RebateCodeServiceResponse;
    public Customer: RebateCodeCustomerResponse;
    public PriceSign: string;

    public constructor(init?: Partial<RebateCodeTransactionQueryResponse>) { (Object as any).assign(this, init); }
}

export class RebateCodeTransactionResponse
{
    public ResponseStatus: ResponseStatus;
    public RebateCodeTransactionItem: RebateCodeTransactionQueryResponse;

    public constructor(init?: Partial<RebateCodeTransactionResponse>) { (Object as any).assign(this, init); }
}

export enum AmountChangeType
{
    Increase = 'Increase',
    Decrease = 'Decrease',
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class CreateRebateCodeTransaction
{
    /** @description  */
    // @ApiMember(Description="", IsRequired=true)
    public CompanyId: string;

    /** @description 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 RebateCodeId: number;

    // @ApiMember(IsRequired=true)
    public Amount: number;

    // @ApiMember(IsRequired=true)
    public Usage: number;

    // @ApiMember()
    public BookingId?: number;

    /** @description 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 ChangeType: AmountChangeType;

    public constructor(init?: Partial<CreateRebateCodeTransaction>) { (Object as any).assign(this, init); }
}

TypeScript 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>