Sidebar
This is an old revision of the document!
Table of Contents
Pos.GetPosSaleItems
Method: Pos/GetPosSaleItems Returns sales from a given period
/// <param name="token">Token</param>
/// <param name="date">Salesdate</param>
/// <param name="ownerid">Club Id</param>
/// <param name="days">number of days to retrieve</param>
/// <param name="itemnamefilter">optional itemname filter</param>
Example: https://demo.clubplanner.be/api/pos/GetPosSaleItems?token=DEMOTOKEN&date=10-8-2018&ownerid=1
Result:
class MemberPosItemResult
{
public int Id { get; set; }
public int MemberId { get; set; }
public string ItemName { get; set; }
public int Quantity { get; set; }
public decimal TotalAmount { get; set; }
public int PayMethodId { get; set; }
public int RevenueGroupId { get; set; }
public int PosPointId { get; set; }
public string CreatedOn { get; set; }
}
Pos.GetCreditItems
Method: Pos/GetCreditItems Returns credit changes from a given period
/// <param name="token">Token</param>
/// <param name="date"></param>
/// <param name="ownerid">Club Id</param>
/// <param name="days">number of days to retrieve</param>
Example: https://demo.clubplanner.be/api/pos/GetCreditItems?token=DEMOTOKEN&date=10-8-2018&ownerid=1&days=100
Result:
class MemberCreditItemResult
{
public int Id { get; set; }
public int MemberId { get; set; }
public decimal Amount { get; set; }
public int PayMethodId { get; set; }
public int PosPointId { get; set; }
public string CreatedOn { get; set; }
public string Note { get; set; }
}
Pos.GetBalanceItems
Method: Pos/GetBalanceItems Returns credit changes from a given period
/// <param name="token">Token</param>
/// <param name="date"></param>
/// <param name="pospointid">PosPoint Id</param>
/// <param name="ownerid">Club Id</param>
/// <param name="days">number of days to retrieve</param>
Result:
class BalanceItemResult {
public int Id { get; set; }
public decimal StartAmount { get; set; }
public decimal EndAmount { get; set; }
public int PosPointId { get; set; }
public int OwnerId { get; set; }
public string StartDate { get; set; }
public string EndDate { get; set; }
public string StartCreatedBy { get; set; }
public string EndCreatedBy { get; set; }
}
Pos.GetMoneyInOutItems
Method: Pos/GetMoneyInOutItems Returns money-in-out records from a given period
/// <param name="token">Token</param>
/// <param name="date"></param>
/// <param name="days">number of days to retrieve</param>
/// <param name="ownerid">Club Id</param>
Result:
class MoneyInOutItemResult {
public int Id { get; set; }
public decimal Amount { get; set; }
public int PosPointId { get; set; }
public string CreatedOn { get; set; }
public string Note { get; set; }
public string CreatedBy { get; set; }
public int OwnerId { get; set; }
}
Pos.UpdateMoneyInOutItem
Method: Pos/UpdateMoneyInOutItem Update 1 money-in-out record
/// <param name="token">Token</param>
/// <param name="id">moneyitem id</param>
/// <param name="amount">new amount</param>
/// <param name="note">new note</param>
/// <param name="ownerid">optional, new Club Id</param>
Pos.DeletePosItem
Method: Pos/DeletePosItem
Deletes a positem
/// <param name="token"></param>
/// <param name="id"></param>
/// <param name="from"></param>
Example: https://demo.clubplanner.be/api/pos/DeletePosItem?token=DEMOTOKEN&id=1
Pos.UpdatePosItem
Method: Pos/UpdatePosItem
Updates a positem
/// <param name="token"></param>
/// <param name="id"></param>
/// <param name="totalamount">optional</param>
/// <param name="quantity">optional</param>
/// <param name="vat">optional</param>
/// <param name="itemname">optional</param>
/// <param name="createdon">optional</param>
/// <param name="ownerid">optional</param>
/// <param name="revenuegroupid">optional</param>
/// <param name="pospointid"></param>
/// <param name="memberid">optional</param>
/// <param name="note">optional</param>
/// <param name="extrainfo">optional</param>
/// <param name="from">optional</param>
Example: https://demo.clubplanner.be/api/pos/UpdatePosItem?token=DEMOTOKEN&id=1&itemname=newdescription
Pos.AddPosItem
Method: Pos/AddPosItem
Add a positem
/// <param name="token"></param>
/// <param name="totalamount"></param>
/// <param name="itemname"></param>
/// <param name="revenuegroupid"></param>
/// <param name="paymethodid"></param>
/// <param name="vat"></param>
/// <param name="memberid"></param>
/// <param name="quantity">optional, default 1</param>
/// <param name="createdon">optional format dd-MM-yyyy HH:mm</param>
/// <param name="ownerid">optional, default 1</param>
/// <param name="pospointid">optional, default 1</param>
/// <param name="note">optional</param>
/// <param name="extrainfo">optional</param>
/// <param name="from">optional</param>
Examples:
Pos.GetPosItems
Method: Pos/GetPosItems
Returns all configured positems
/// <param name="token">Token</param>
Example: https://demo.clubplanner.be/api/pos/GetPosItems?token=DEMOTOKEN
Pos.GetRevenueGroups
Method: Pos/GetRevenueGroups
Returns all configured RevenueGroups
/// <param name="token">Token</param>
Example: https://demo.clubplanner.be/api/pos/GetRevenueGroups?token=DEMOTOKEN
Pos.GetPosGroups
Method: Pos/GetPosGroups
Returns all configured PosGroups
/// <param name="token">Token</param>
Example: https://demo.clubplanner.be/api/pos/GetPosGroups?token=DEMOTOKEN
Pos.GetCoupon
Method: Pos/GetCoupon
Returns a coupon with a given id
/// <param name="token">Token</param>
/// <param name="couponid">id of the coupon, optional</param>
/// <param name="couponkey">key of the coupon, optional</param>
Example: https://demo.clubplanner.be/api/pos/getcoupon?token=DEMOTOKEN&couponid=222
Pos.AddCoupon
Method: Pos/AddCoupon
Adds a coupon
/// <param name="token">Token</param>
/// <param name="memberid">member used to store the sale against, has no further meaning</param>
/// <param name="amount">amount of the coupon</param>
/// <param name="note">optional: note, extra information you want to add</param>
/// <param name="name">optional: name that will be used in sold items list in POS </param>
/// <param name="from">optional: who added this coupon</param>
Pos.UpdateCoupon
Method: Pos/UpdateCoupon
Updates a given coupon
/// <param name="token">Token</param>
/// <param name="couponid">id of the coupon</param>
/// <param name="remainder">remainder amount of the coupon</param>
/// <param name="note">optional: note, extra information you want to update</param>
Example: https://demo.clubplanner.be/api/pos/UpdateCoupon?token=DEMOTOKEN&remainder=5¬e=extra-data
Pos.GetInvoiceRelations
Method: Pos/GetInvoiceRelations
Returns a list of InvoiceRelations
Example: https://demo.clubplanner.be/api/pos/GetInvoiceRelations?token=DEMOTOKEN
Pos.GetInvoices
Method: Pos/GetInvoices
Returns a list of invoices
/// <param name="token">Token</param>
/// <param name="date">created on date</param>
/// <param name="days">number of days to retrieve, default 1</param>
/// <param name="relationid">id of the relation, default 0 = no filter</param>
Example: https://demo.clubplanner.be/api/pos/GetInvoices?token=DEMOTOKEN&date=1-1-2023&days=30
Pos.GetInvoice
Method: Pos/GetInvoice
Returns an invoice
/// <param name="token">Token</param>
/// <param name="invoiceid">id of the invoice</param>
Example: https://demo.clubplanner.be/api/pos/GetInvoice?token=DEMOTOKEN&invoiceid=201201
Pos.GetOrders
Method: Pos/GetOrders
Returns a list of Orders on a given date
/// <param name="token">Token</param>
/// <param name="date">optional date, default today</param>
Example: https://demo.clubplanner.be/api/pos/GetOrders?token=DEMOTOKEN&date=1-AUG-2023
