Fieldpine Logo Documentation Home  

retailmax.elink.sale.totals.group


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#NameDescription
3Required. Must be "retailmax.elink.sale.totals.group"
7, 10Want list. Specifies which information is to be returned.
8MaxRowsMaximum number of rows to return
9FiltersList of restrictions to apply to sales. This allows you to select a subset of sales
12SortAsc
13SortDesc
15GroupingRequired. Sets the attribute used to group results by. Possible values are
  • Pid
  • TaxRate
  • Spid
  • Depid
  • Tid
  • Cid
  • Location
  • General Grouping

Filters

Arg#NameDescription
f100Sales Location
f110Sale Completion Date/Time
f127Accounting Transfer Date/Time
f140Customer Id
f147Xero Transfer date/time
f1000Pid (Product Id)
f1001SalesType
f1002Product department
f1003Product Supplier Id
f1004Product Consignment indicator
f1005IdSet. Sets that can generate against sales or salelines are acceptable
f1006Discount Id applied

Response

Arg#NameDescription
f100Sales Location

Examples

Get a summary of sales:

/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>