Get Summary By Contact
NsApiSlow threshold: 3000 ms.
Authorizations
SuperOffice username:password are passed in Base64-encoded.
You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.
SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/
passing in the application id and redirect URL.
SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)
https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f
You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.
- Authorization URL
- https://online.superoffice.com/login/common/oauth/authorize
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
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.
Body
ContactId, FromDate, ToDate
Response
OK
Carrier object for SaleSummary. Services for the SaleSummary Carrier is available from the Sale Agent.
Default currency for the installation
Default currency for the current user
Summed amount for all sold within the period in default currency for the installation
Number of all sold within the period
Summed amount for all sold within the period in default currency for the current user
Number of all lost within the period
Summed amount for all lost within the period in default currency for the installation
Summed amount for all lost within the period in default currency for the current user
Number of all open within the period
Summed amount for all open within the period in default currency for the installation
Summed amount for all open within the period in default currency for the current user
Weighted sum for all open within the period in default currency for the installation
Weighted sum for all open within the period in default currency for the current user
Number of all open sales with date before this period
Summed amount for all open sales with date before this period in default currency for the installation
Summed amount for all open sales with date before this period in default currency for the current user
Weighted sum for all open sales with date before this period in default currency for the installation
Weighted sum for all open sales with date before this period in default currency for the current user
Number of all overdue sales within the period
Summed amount for all overdue sales within the period in default currency for the installation
Summed amount for all overdue sales within the period in default currency for the current user
Weighted sum for all overdue sales within the period in default currency for the installation
Weighted sum for all overdue sales within the period in default currency for the current user
Number of all Future Pipe/All open sales with date after the period
Summed amount for all Future Pipe/All open sales with date after the period in default currency for the installation
Summed amount for all Future Pipe/All open sales with date after the period in default currency for the current user
Weighted sum for all Future Pipe/All open sales with date after the period in default currency for the installation
Weighted sum for all Future Pipe/All open sales with date after the period in default currency for the current user
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Field property dictionary mapping field names to field access rights.