Sale Totals Group Bucket

This API summarises sales for reporting purposes. It allows filtering by various attributes and can group the output several different dimensions. This API is most useful for building reports that are based on sales.

Goto: eLink Home

Input Arguments

Arg#	Name	Description
3		Required. Must be "retailmax.elink.sale.totals.group"
7, 10		Want list. Specifies which information is to be returned.
8	MaxRows	Maximum number of rows to return
9	Filters	List of restrictions to apply to sales. This allows you to select a subset of sales
12	SortAsc
13	SortDesc
15	Grouping	Required. Sets the attribute used to group results by. Possible values are Pid TaxRate Spid Depid Tid Cid Location General Grouping

Filters

Arg#	Name	Description
f100		Sales Location
f110		Sale Completion Date/Time
f127		Accounting Transfer Date/Time
f140		Customer Id
f147		Xero Transfer date/time
f1000		Pid (Product Id)
f1001		SalesType
f1002		Product department
f1003		Product Supplier Id
f1004		Product Consignment indicator
f1005		IdSet. Sets that can generate against sales or salelines are acceptable
f1006		Discount Id applied

Response

Arg#	Name	Description
f100		Sales Location

Examples

Get a summary of sales:

Within the last 400 days (&9=f110,4,today-400)
Summarised/Grouped by supplier (&15=2,1,spid)
Sorted by total revenue descending (&13=120)

/gnap/M/BUCK?3=retailmax.elink.sale.totals.group&15=2,1,spid&13=120&9=f110,4,today-400

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> 
<ARAY>
 <APPD>
  <f1003>398</f1003> 
  <CalcType>A</CalcType> 
  <RevenueExTax>686.000000</RevenueExTax> 
  <RevenueIncTax>788.890000</RevenueIncTax> 
  <TaxTr1>102.890000</TaxTr1> 
  <TaxTr2>0.000000</TaxTr2> 
  <TaxTr3>0.000000</TaxTr3> 
  <CostUnits>86.150000</CostUnits> 
  <f102>278.711750</f102> 
  <TotalQty>27.000000</TotalQty> 
  <Measure>Unit</Measure> 
  <LineCount>15</LineCount> 
  <f107>73.273000</f107> 
  <f207>Kg</f207> 
  <f108>48</f108> 
  <SupplierName>GENERIC</SupplierName> 
 </APPD>
 ....
</ARAY>