POST Agents/Sale/GetSummaryByGroup

Some tooltip text!

• 6 minutes to read

 • 6 minutes to read

POST /api/v1/Agents/Sale/GetSummaryByGroup

Query String Parameters

Parameter Name	Type	Description
$select	string	Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

POST /api/v1/Agents/Sale/GetSummaryByGroup?$select=name,department,category/id

Request Headers

Parameter Name	Description
Authorization	Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN	If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type	Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept	Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language	Convert string references and multi-language values into a specified language (iso2) code.
SO-Language	Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture	Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone	Specify the timezone code that you would like date/time responses converted to.
SO-AppToken	The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

GroupId, FromDate, ToDate

Property Name	Type	Description
GroupId	Integer
FromDate	String
ToDate	String

Response:

OK

Response	Description
200	OK

Response body: SaleSummary

Property Name	Type	Description
BaseCurrency	string	Default currency for the installation
OwnCurrency	string	Default currency for the current user
SoldTotalBaseCurrency	double	Summed amount for all sold within the period in default currency for the installation
Sold	int32	Number of all sold within the period
SoldTotalOwnCurrency	double	Summed amount for all sold within the period in default currency for the current user
Lost	int32	Number of all lost within the period
LostTotalBaseCurrency	double	Summed amount for all lost within the period in default currency for the installation
LostTotalOwnCurrency	double	Summed amount for all lost within the period in default currency for the current user
Open	int32	Number of all open within the period
OpenTotalBaseCurrency	double	Summed amount for all open within the period in default currency for the installation
OpenTotalOwnCurrency	double	Summed amount for all open within the period in default currency for the current user
OpenWeightedBaseCurrency	double	Weighted sum for all open within the period in default currency for the installation
OpenWeightedOwnCurrency	double	Weighted sum for all open within the period in default currency for the current user
PreviousOverdue	int32	Number of all open sales with date before this period
PreviousOverdueTotalBaseCurrency	double	Summed amount for all open sales with date before this period in default currency for the installation
PreviousOverdueTotalOwnCurrency	double	Summed amount for all open sales with date before this period in default currency for the current user
PreviousOverdueWeightedBaseCurrency	double	Weighted sum for all open sales with date before this period in default currency for the installation
PreviousOverdueWeightedOwnCurrency	double	Weighted sum for all open sales with date before this period in default currency for the current user
CurrentOverdue	int32	Number of all overdue sales within the period
CurrentOverdueTotalBaseCurrency	double	Summed amount for all overdue sales within the period in default currency for the installation
CurrentOverdueTotalOwnCurrency	double	Summed amount for all overdue sales within the period in default currency for the current user
CurrentOverdueWeightedBaseCurrency	double	Weighted sum for all overdue sales within the period in default currency for the installation
CurrentOverdueWeightedOwnCurrency	double	Weighted sum for all overdue sales within the period in default currency for the current user
FutureOpen	int32	Number of all Future Pipe/All open sales with date after the period
FutureOpenTotalBaseCurrency	double	Summed amount for all Future Pipe/All open sales with date after the period in default currency for the installation
FutureOpenTotalOwnCurrency	double	Summed amount for all Future Pipe/All open sales with date after the period in default currency for the current user
FutureOpenWeightedBaseCurrency	double	Weighted sum for all Future Pipe/All open sales with date after the period in default currency for the installation
FutureOpenWeightedOwnCurrency	double	Weighted sum for all Future Pipe/All open sales with date after the period in default currency for the current user
TableRight	TableRight	The carrier's table right
FieldProperties	object	Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Sale/GetSummaryByGroup
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "GroupId": 484,
  "FromDate": "2007-07-31T17:54:03.6014331+02:00",
  "ToDate": "2002-02-24T17:54:03.6014331+01:00"
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "BaseCurrency": "quis",
  "OwnCurrency": "delectus",
  "SoldTotalBaseCurrency": 19747.334,
  "Sold": 188,
  "SoldTotalOwnCurrency": 20302.052,
  "Lost": 171,
  "LostTotalBaseCurrency": 29798.072,
  "LostTotalOwnCurrency": 19111.131999999998,
  "Open": 438,
  "OpenTotalBaseCurrency": 21007.201999999997,
  "OpenTotalOwnCurrency": 22520.924,
  "OpenWeightedBaseCurrency": 15597.918,
  "OpenWeightedOwnCurrency": 858.716,
  "PreviousOverdue": 354,
  "PreviousOverdueTotalBaseCurrency": 15481.96,
  "PreviousOverdueTotalOwnCurrency": 4378.1979999999994,
  "PreviousOverdueWeightedBaseCurrency": 28021.093999999997,
  "PreviousOverdueWeightedOwnCurrency": 18700.577999999998,
  "CurrentOverdue": 424,
  "CurrentOverdueTotalBaseCurrency": 21859.649999999998,
  "CurrentOverdueTotalOwnCurrency": 26861.514,
  "CurrentOverdueWeightedBaseCurrency": 3431.73,
  "CurrentOverdueWeightedOwnCurrency": 17885.738,
  "FutureOpen": 234,
  "FutureOpenTotalBaseCurrency": 1573.268,
  "FutureOpenTotalOwnCurrency": 17609.946,
  "FutureOpenWeightedBaseCurrency": 16437.829999999998,
  "FutureOpenWeightedOwnCurrency": 2692.1059999999998,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 109
    }
  }
}