API WIKI

User Tools

Site Tools

Trace:
pos

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
pos [2022/04/21 15:07]
clubadmin 		pos [2024/03/25 15:04] (current)
Line 86: Line 86:
  
 Method: Pos/GetMoneyInOutItems Method: Pos/GetMoneyInOutItems
-Returns credit changes from a given period +Returns money-in-out records from a given period 
         /// <param name="token">Token</param>         /// <param name="token">Token</param>
         /// <param name="date"></param>         /// <param name="date"></param>
Line 106: Line 106:
     public int OwnerId { get; set; }     public int OwnerId { get; set; }
 } }
 +
 +===== Pos.UpdateMoneyInOutItem =====
 +
 +Method: Pos/UpdateMoneyInOutItem
 +
 +Updates 1 money-in-out item for a given id.
 +
 +        /// <param name="token">Token</param>
 +        /// <param name="id">moneyitem id</param>
 +        /// <param name="amount">optional new amount</param>
 +        /// <param name="createdon">optional, new createdon timestamp</param>
 +        /// <param name="note">optional, new note</param>
 +        /// <param name="ownerid">optional, new club id</param>
  
 ===== Pos.DeletePosItem ===== ===== Pos.DeletePosItem =====
Line 133: Line 146:
         /// <param name="pospointid"></param>         /// <param name="pospointid"></param>
         /// <param name="memberid">optional</param>         /// <param name="memberid">optional</param>
 +        /// <param name="note">optional</param>
 +        /// <param name="extrainfo">optional</param> 
         /// <param name="from">optional</param>         /// <param name="from">optional</param>
  
Line 153: Line 168:
         /// <param name="createdon">optional format dd-MM-yyyy HH:mm</param>         /// <param name="createdon">optional format dd-MM-yyyy HH:mm</param>
         /// <param name="ownerid">optional, default 1</param>                /// <param name="ownerid">optional, default 1</param>       
-        /// <param name="pospointid">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>         /// <param name="from">optional</param>
  
Line 199: Line 216:
  
 Returns a coupon with a given id 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>
 +Example: https://demo.clubplanner.be/api/pos/addcoupon?token=DEMOTOKEN&memberid=1&amount=10&note=extra-data&from=mywebpage
 +
 +===== Pos.UpdateCoupon =====
 +
 +Method: Pos/UpdateCoupon 
 +
 +Updates a given coupon
         /// <param name="token">Token</param>         /// <param name="token">Token</param>
         /// <param name="couponid">id of the coupon</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&note=extra-data
  
-Example: https://demo.clubplanner.be/api/pos/getcoupon?token=DEMOTOKEN&couponid=222+ 
 +===== 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
pos.1650546470.txt.gz · Last modified: 2022/04/21 15:07 by clubadmin

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki