BokaMera.API.Host

CreateRebateCode

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
POST	/rebatecodes	Create RebateCode.	Create RebateCode.

**CreateRebateCode** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	body	Guid?	No
MaxNumberOfUses	body	int?	No	The default value is 9999
MaxNumberOfUsesPerCustomer	body	int?	No	The default value is 1
ValidFrom	body	DateTime	Yes
ValidTo	body	DateTime	Yes
FromTime	body	TimeSpan?	No	If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.
ToTime	body	TimeSpan?	No	If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.
RebateCodeTypeId	body	int	Yes	1 - Percent, 2 - Сurrency, 3 - PunchTicket, 4 - ValueCard, 5 - GiftCard
ArticleId	body	int?	No	If it's connected to an Article, add the Article Id here.
RebateCodeValue	body	int	Yes
RebateCodeSign	body	string	Yes	If AutoGenerateRebateCodeSign=false - more than four letters, unique among active codes
AutoGenerateRebateCodeSign	body	bool	No	AutoGenerateRebateCodeSign=true - random generate code
PersonalNote	body	string	Yes
DaysOfWeek	body	List<int>	Yes
Services	body	List<int>	Yes
Customers	body	List<Guid>	Yes
PriceVat	body	decimal?	No	The price
CurrencyId	body	string	Yes	The price currency
PromoCodeReceiver	body	PromoCodeReceiver	Yes	Promo code receiver information
InvoiceAddress	body	InvoiceAddressToHandle	No	If you wish to save some invoice address information for the rebate code, you can do so here. This is optional.

**PromoCodeReceiver** Parameters:
Name	Parameter	Data Type	Required
CustomerId	form	Guid?	No
Firstname	form	string	Yes
Lastname	form	string	Yes
Email	form	string	Yes
ReceiverMessage	form	string	Yes

**InvoiceAddressToHandle** Parameters:
Name	Parameter	Data Type	Required
CorporateIdentityNumber	form	string	Yes
InvoiceAddress1	form	string	Yes
InvoiceAddress2	form	string	Yes
InvoiceCity	form	string	Yes
InvoicePostalCode	form	string	Yes
InvoiceCountryCode	form	string	Yes

**RebateCodeResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
CompanyId	form	Guid?	No
ValidFrom	form	DateTime	No
ValidTo	form	DateTime	No
FromTime	form	TimeSpan	No	If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.
ToTime	form	TimeSpan	No	If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.
CreatedBy	form	string	Yes
Created	form	DateTime	No
UpdatedBy	form	string	Yes
Updated	form	DateTime	No
PersonalNote	form	string	Yes
RebateCodeSign	form	string	Yes
RebateCodeValue	form	int	No
RebateCodeTypeId	form	int	No
Name	form	string	Yes
RebateCodeStatusId	form	int	No
StatusName	form	string	Yes
MaxNumberOfUses	form	int	No
MaxNumberOfUsesPerCustomer	form	int	No
NumberOfUsesUsed	form	int	No
DaysOfWeek	form	List<DaysOfWeekResponse>	Yes
Services	form	List<RebateCodeServiceResponse>	Yes
Article	form	ArticleResponse	Yes
Transactions	form	List<RebateCodeTransactionQueryResponse>	Yes
RemainingAmount	form	double?	No
RemainingUsage	form	int?	No
Customers	form	List<RebateCodeCustomerResponse>	Yes
ResponseStatus	form	ResponseStatus	Yes
PaymentReceived	form	bool	No
RebateCodeCurrencySign	form	string	Yes
ActiveByStatus	form	bool	No
PriceSign	form	string	Yes
RebateCodeTypeName	form	string	Yes
Company	form	RebateCodeCompanyResponse	Yes

**DaysOfWeekResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
DayOfWeek	form	string	Yes
DayOfWeekTranslation	form	string	Yes
DayOfWeekActive	form	bool?	No
DayOfWeekSortOrder	form	short?	No

**RebateCodeServiceResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	Yes
Description	form	string	Yes
Active	form	bool	No

**ArticleResponse** Parameters:
Name	Parameter	Data Type	Required
CompanyId	form	Guid	No
Id	form	int	No
Name	form	string	Yes
ArticleTypeId	form	int	No
Description	form	string	Yes
ImageUrl	form	string	Yes
Active	form	bool	No
Amount	form	int	No
Price	form	double	No
CurrencyId	form	string	Yes
UpdatedDate	form	DateTime	No
CreatedDate	form	DateTime	No
Services	form	List<ArticleServiceRelation>	Yes
ServiceIds	form	List<int>	Yes
PriceSign	form	string	Yes
VAT	form	decimal?	No

**ArticleServiceRelation** Parameters:
Name	Parameter	Data Type	Required
CompanyId	form	Guid	Yes
Id	form	int	No
ServiceId	form	int	Yes
ArticleId	form	int	Yes

**RebateCodeTransactionQueryResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
CompanyId	form	Guid	No
Note	form	string	Yes
RebateCodeId	form	int	No
RebateCodeSign	form	string	Yes
RebateCodeTypeId	form	int?	No
RebateCodeTypeName	form	string	Yes
Amount	form	double	No
Usage	form	string	Yes
BookingId	form	int?	No
UpdatedDate	form	DateTime	No
CreatedDate	form	DateTime	No
Service	form	RebateCodeServiceResponse	Yes
Customer	form	RebateCodeCustomerResponse	Yes
PriceSign	form	string	Yes

**RebateCodeCustomerResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Firstname	form	string	Yes
Lastname	form	string	Yes
Email	form	string	Yes
Phone	form	string	Yes
ImageUrl	form	string	Yes

**RebateCodeCompanyResponse** Parameters:
Name	Parameter	Data Type	Required	Description
SitePath	form	string	Yes
PaymentProviderId	form	int?	No

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /rebatecodes HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	MaxNumberOfUses: 0,
	MaxNumberOfUsesPerCustomer: 0,
	FromTime: PT0S,
	ToTime: PT0S,
	RebateCodeTypeId: 0,
	ArticleId: 0,
	RebateCodeValue: 0,
	RebateCodeSign: String,
	AutoGenerateRebateCodeSign: False,
	PersonalNote: String,
	DaysOfWeek: 
	[
		0
	],
	Services: 
	[
		0
	],
	Customers: 
	[
		00000000-0000-0000-0000-000000000000
	],
	PriceVat: 0,
	CurrencyId: String,
	PromoCodeReceiver: 
	{
		CustomerId: 00000000-0000-0000-0000-000000000000,
		Firstname: String,
		Lastname: String,
		Email: String,
		ReceiverMessage: String
	},
	InvoiceAddress: 
	{
		CorporateIdentityNumber: String,
		InvoiceAddress1: String,
		InvoiceAddress2: String,
		InvoiceCity: String,
		InvoicePostalCode: String,
		InvoiceCountryCode: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	CompanyId: 00000000-0000-0000-0000-000000000000,
	FromTime: PT0S,
	ToTime: PT0S,
	CreatedBy: String,
	UpdatedBy: String,
	PersonalNote: String,
	RebateCodeSign: String,
	RebateCodeValue: 0,
	RebateCodeTypeId: 0,
	Name: String,
	RebateCodeStatusId: 0,
	StatusName: String,
	MaxNumberOfUses: 0,
	MaxNumberOfUsesPerCustomer: 0,
	NumberOfUsesUsed: 0,
	DaysOfWeek: 
	[
		{
			Id: 0,
			DayOfWeek: String,
			DayOfWeekTranslation: String,
			DayOfWeekActive: False,
			DayOfWeekSortOrder: 0
		}
	],
	Services: 
	[
		{
			Id: 0,
			Name: String,
			Description: String,
			Active: False
		}
	],
	Article: 
	{
		Id: 0,
		Name: String,
		ArticleTypeId: 0,
		Description: String,
		ImageUrl: String,
		Active: False,
		Amount: 0,
		Price: 0,
		CurrencyId: String,
		Services: 
		[
			{
				Id: 0,
				ServiceId: 0,
				ArticleId: 0
			}
		],
		ServiceIds: 
		[
			0
		],
		PriceSign: String,
		VAT: 0
	},
	Transactions: 
	[
		{
			Id: 0,
			Note: String,
			RebateCodeId: 0,
			RebateCodeSign: String,
			RebateCodeTypeId: 0,
			RebateCodeTypeName: String,
			Amount: 0,
			Usage: String,
			BookingId: 0,
			Service: 
			{
				Id: 0,
				Name: String,
				Description: String,
				Active: False
			},
			Customer: 
			{
				Firstname: String,
				Lastname: String,
				Email: String,
				Phone: String,
				ImageUrl: String
			},
			PriceSign: String
		}
	],
	RemainingAmount: 0,
	RemainingUsage: 0,
	Customers: 
	[
		{
			Firstname: String,
			Lastname: String,
			Email: String,
			Phone: String,
			ImageUrl: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	PaymentReceived: False,
	RebateCodeCurrencySign: String,
	ActiveByStatus: False,
	PriceSign: String,
	RebateCodeTypeName: String,
	Company: 
	{
		SitePath: String,
		PaymentProviderId: 0
	}
}