POST Agents/Sale/CreateDefaultSaleSummary
Some tooltip text!
• 6 minutes to read
• 6 minutes to read
POST /api/v1/Agents/Sale/CreateDefaultSaleSummary
Set default values into a new SaleSummary.
NetServer calculates default values on the entity, which is required when creating/storing a new instance
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 |
| 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. |
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/CreateDefaultSaleSummary
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: *
Sample response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"BaseCurrency": "fuga",
"OwnCurrency": "quo",
"SoldTotalBaseCurrency": 22981.622,
"Sold": 76,
"SoldTotalOwnCurrency": 29650.773999999998,
"Lost": 165,
"LostTotalBaseCurrency": 27955.28,
"LostTotalOwnCurrency": 29190.075999999997,
"Open": 224,
"OpenTotalBaseCurrency": 6098.764,
"OpenTotalOwnCurrency": 2178.13,
"OpenWeightedBaseCurrency": 20740.811999999998,
"OpenWeightedOwnCurrency": 2265.882,
"PreviousOverdue": 973,
"PreviousOverdueTotalBaseCurrency": 17797.986,
"PreviousOverdueTotalOwnCurrency": 27920.806,
"PreviousOverdueWeightedBaseCurrency": 26037.272,
"PreviousOverdueWeightedOwnCurrency": 5255.718,
"CurrentOverdue": 391,
"CurrentOverdueTotalBaseCurrency": 13570.22,
"CurrentOverdueTotalOwnCurrency": 833.644,
"CurrentOverdueWeightedBaseCurrency": 11379.554,
"CurrentOverdueWeightedOwnCurrency": 16654.076,
"FutureOpen": 978,
"FutureOpenTotalBaseCurrency": 7574.878,
"FutureOpenTotalOwnCurrency": 10602.322,
"FutureOpenWeightedBaseCurrency": 8029.308,
"FutureOpenWeightedOwnCurrency": 23357.701999999997,
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 901
}
}
}