BokaMera.API.Host

<back to all web services

MarkRebateCodeAsPayed

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
POST/rebatecodes/markaspayedMark rebate code as payedMark rebate code as payed
MarkRebateCodeAsPayed Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?Yes
RebateCodeIdbodyintYesRebate code id to which you wish to add transaction
RebateCodeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CompanyIdformGuid?No
ValidFromformDateTimeNo
ValidToformDateTimeNo
FromTimeformTimeSpanNoIf 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.
ToTimeformTimeSpanNoIf the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.
CreatedByformstringNo
CreatedformDateTimeNo
UpdatedByformstringNo
UpdatedformDateTimeNo
PersonalNoteformstringNo
RebateCodeSignformstringNo
RebateCodeValueformintNo
RebateCodeTypeIdformintNo
NameformstringNo
RebateCodeStatusIdformintNo
StatusNameformstringNo
MaxNumberOfUsesformintNo
MaxNumberOfUsesPerCustomerformintNo
NumberOfUsesUsedformintNo
DaysOfWeekformList<DaysOfWeekResponse>No
ServicesformList<RebateCodeServiceResponse>No
ArticleformArticleResponseNo
TransactionsformList<RebateCodeTransactionQueryResponse>No
RemainingAmountformdouble?No
RemainingUsageformint?No
CustomersformList<RebateCodeCustomerResponse>No
ResponseStatusformResponseStatusNo
PaymentReceivedformboolNo
RebateCodeCurrencySignformstringNo
ActiveByStatusformboolNo
PriceSignformstringNo
RebateCodeTypeNameformstringNo
DaysOfWeekResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DayOfWeekformstringNo
DayOfWeekTranslationformstringNo
DayOfWeekActiveformbool?No
DayOfWeekSortOrderformshort?No
RebateCodeServiceResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
ActiveformboolNo
ArticleResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
IdformintNo
NameformstringNo
ArticleTypeIdformintNo
DescriptionformstringNo
ImageUrlformstringNo
ActiveformboolNo
AmountformintNo
PriceformdoubleNo
CurrencyIdformstringNo
UpdatedDateformDateTimeNo
CreatedDateformDateTimeNo
ServicesformList<ArticleServiceRelation>No
ServiceIdsformList<int>No
PriceSignformstringNo
ArticleServiceRelation Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformintNo
ServiceIdformintYes
ArticleIdformintYes
RebateCodeTransactionQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CompanyIdformGuidNo
NoteformstringNo
RebateCodeIdformintNo
RebateCodeSignformstringNo
RebateCodeTypeIdformint?No
RebateCodeTypeNameformstringNo
AmountformdoubleNo
BookingIdformint?No
UpdatedDateformDateTimeNo
CreatedDateformDateTimeNo
ServiceformRebateCodeServiceResponseNo
CustomerformRebateCodeCustomerResponseNo
PriceSignformstringNo
RebateCodeCustomerResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
FirstnameformstringNo
LastnameformstringNo
EmailformstringNo
PhoneformstringNo
ImageUrlformstringNo

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

HTTP + OTHER

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

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

{"CompanyId":"00000000-0000-0000-0000-000000000000","RebateCodeId":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Id":0,"CompanyId":"00000000-0000-0000-0000-000000000000","FromTime":"00:00:00","ToTime":"00:00:00","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"},"Transactions":[{"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"}],"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"}