GET Sale/{id}/Simple

• 4 minutes to read

GET /api/v1/Sale/{id}/Simple

A simple Sale object.

This is a simpler, smaller variation of the full SaleEntity. Calls the Sale agent service GetSale.

Path Part	Type	Description
id	int32	The id of the Sale to return. Required

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:

SaleEntity found.

Response	Description
200	SaleEntity found.
404	Not Found.

Response body: Sale

Property Name	Type	Description
ContactName	string	Contact name
SaleDate	date-time	(expected / lost / won) sales date
SaleId	int32	Primary key
Probability	int32	Actual probability, may differ from the one in the list
Title	string	Sale heading (short description?)
Amount	double	Total sale amount
Currency	string	Currency the sale was made in.
ProjectName	string	Project name
AssociateFullName	string	The sale's owner
Description	string	The sales description
Status	string	The sale's status, indicating wether the sale is open, sold or lost.
WeightedAmount	double	The weighted amount ( amount * probability / 100)
ProjectId	int32	Optional project reference
EarningPercent	double	Earning as percent of total
Earning	double	Earning on sale
ContactId	int32	Optional contact reference
AssociateId	int32	The sale's owner id
PersonId	int32	The sale's contact persons id
SaleTypeId	int32	The sale's type id
SaleTypeName	string	The sale's type name
PersonFullName	string	The name of the person this sale belongs to.
Completed	string	The Sale completed state. The completed state is either Started or Completed. NotStarted is treated as Started. The value maps to the Done database field.
ActiveErpLinks	int32	The number of active erp links
NextDueDate	date-time	Next due date, this is a denormalization of 'closest future activity date, or most recent if no future activities'. Maintained by the system, but very convenient for searching.
Number	string	Alphanumeric user field
TableRight	TableRight	The carrier's table right
FieldProperties	object	Field property dictionary mapping field names to field access rights.

Sample request

GET /api/v1/Sale/{id}/Simple
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

HTTP/1.1 200 SaleEntity found.
Content-Type: application/json; charset=utf-8

{
  "ContactName": "Jacobson-McGlynn",
  "SaleDate": "2000-12-29T02:30:52.8974033+01:00",
  "SaleId": 801,
  "Probability": 168,
  "Title": "consequatur",
  "Amount": 3591.564,
  "Currency": "sit",
  "ProjectName": "Miller Group",
  "AssociateFullName": "Horacio Feil",
  "Description": "Extended global architecture",
  "Status": "Lost",
  "WeightedAmount": 20026.26,
  "ProjectId": 889,
  "EarningPercent": 18982.638,
  "Earning": 9311.114,
  "ContactId": 535,
  "AssociateId": 590,
  "PersonId": 184,
  "SaleTypeId": 165,
  "SaleTypeName": "Ferry Group",
  "PersonFullName": "Lorenzo Heller",
  "Completed": "Completed",
  "ActiveErpLinks": 314,
  "NextDueDate": "2016-06-20T02:30:52.8974033+02:00",
  "Number": "1021871",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 358
    }
  }
}