Get Sale Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/Sale/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:53294/api/v1/Sale/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "53294",
  CURLOPT_URL => "http://localhost:53294/api/v1/Sale/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:53294/api/v1/Sale/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Appointment": {
    "AppointmentId": 123,
    "StartDate": "2023-11-07T05:31:56Z",
    "EndDate": "2023-11-07T05:31:56Z",
    "Type": "Unknown",
    "Task": "<string>",
    "AssociateFullName": "<string>",
    "ContactName": "<string>",
    "Description": "<string>",
    "PersonFullName": "<string>",
    "PersonId": 123,
    "ContactId": 123,
    "ProjectId": 123,
    "ProjectName": "<string>",
    "IsPublished": true,
    "AssociateId": 123,
    "ColorIndex": 123,
    "IsFree": true,
    "HasAlarm": true,
    "IsAlldayEvent": true,
    "Private": "Public",
    "PriorityId": 123,
    "PriorityName": "<string>",
    "TaskType": "Unknown",
    "IsBookingMain": true,
    "IsRecurrence": true,
    "IsBooking": true,
    "ActiveDate": "2023-11-07T05:31:56Z",
    "AssignmentStatus": "Unknown",
    "InvitationStatus": "Unknown",
    "BookingType": "Unknown",
    "Completed": "Unknown",
    "RecurringPattern": "Unknown",
    "RecurringStartDate": "2023-11-07T05:31:56Z",
    "RecurringEndDate": "2023-11-07T05:31:56Z",
    "MotherId": 123,
    "AssignedBy": 123,
    "AssignedByFullName": "<string>",
    "RejectReason": "<string>",
    "Location": "<string>",
    "AlarmLeadTime": "<string>",
    "SaleId": 123,
    "SaleName": "<string>",
    "AssociateName": "<string>",
    "CreatedDate": "2023-11-07T05:31:56Z",
    "CreatedBy": "<string>",
    "CreatedByFullName": "<string>",
    "CreatedByAssociateId": 123,
    "CautionWarning": "OK",
    "OwnedExternally": "None",
    "MotherAssociateId": 123,
    "JoinVideomeetUrl": "<string>",
    "PreferredTZLocation": 123,
    "Title": "<string>",
    "Agenda": "<string>",
    "InternalNotes": "<string>",
    "TaskId": 123,
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Associate": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "UpdatedBy": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "CreatedBy": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Contact": {
    "ContactId": 123,
    "Name": "<string>",
    "OrgNr": "<string>",
    "Department": "<string>",
    "URL": "<string>",
    "City": "<string>",
    "DirectPhone": "<string>",
    "AssociateId": 123,
    "CountryId": 123,
    "EmailAddress": "<string>",
    "Kananame": "<string>",
    "EmailAddressName": "<string>",
    "URLName": "<string>",
    "AssociateFullName": "<string>",
    "BusinessName": "<string>",
    "CategoryName": "<string>",
    "CountryName": "<string>",
    "Address": {
      "Wgs84Latitude": 123,
      "Wgs84Longitude": 123,
      "LocalizedAddress": [
        [
          {
            "Name": "<string>",
            "Value": "<string>",
            "Tooltip": "<string>",
            "Label": "<string>",
            "ValueLength": 123,
            "AddressType": "<string>",
            "TableRight": {
              "Mask": "<string>",
              "Reason": "<string>"
            },
            "FieldProperties": {}
          }
        ]
      ],
      "Street": {
        "AtypeIdx": "Unknown",
        "Address1": "<string>",
        "Address2": "<string>",
        "Address3": "<string>",
        "City": "<string>",
        "County": "<string>",
        "State": "<string>",
        "Zipcode": "<string>",
        "Formatted": "<string>"
      },
      "Postal": {
        "AtypeIdx": "Unknown",
        "Address1": "<string>",
        "Address2": "<string>",
        "Address3": "<string>",
        "City": "<string>",
        "County": "<string>",
        "State": "<string>",
        "Zipcode": "<string>",
        "Formatted": "<string>"
      },
      "Formatted": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    },
    "FormattedAddress": "<string>",
    "FullName": "<string>",
    "IsOwnerContact": true,
    "ActiveErpLinks": 123,
    "Number1": "<string>",
    "Number2": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Project": {
    "ProjectId": 123,
    "Name": "<string>",
    "Description": "<string>",
    "URL": "<string>",
    "Type": "<string>",
    "AssociateId": 123,
    "AssociateFullName": "<string>",
    "TypeId": 123,
    "Updated": "2023-11-07T05:31:56Z",
    "StatusId": 123,
    "Status": "<string>",
    "TextId": 123,
    "PublishTo": "2023-11-07T05:31:56Z",
    "PublishFrom": "2023-11-07T05:31:56Z",
    "IsPublished": true,
    "URLName": "<string>",
    "ProjectNumber": "<string>",
    "ActiveErpLinks": 123,
    "EventId": 123,
    "StartDate": "2023-11-07T05:31:56Z",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "SaleText": "<string>",
  "Person": {
    "Position": "<string>",
    "PersonId": 123,
    "Mrmrs": "<string>",
    "Firstname": "<string>",
    "Lastname": "<string>",
    "MiddleName": "<string>",
    "Title": "<string>",
    "Description": "<string>",
    "Email": "<string>",
    "FullName": "<string>",
    "DirectPhone": "<string>",
    "FormalName": "<string>",
    "CountryId": 123,
    "ContactId": 123,
    "ContactName": "<string>",
    "Retired": 123,
    "Rank": 123,
    "ActiveInterests": 123,
    "ContactDepartment": "<string>",
    "ContactCountryId": 123,
    "ContactOrgNr": "<string>",
    "FaxPhone": "<string>",
    "MobilePhone": "<string>",
    "ContactPhone": "<string>",
    "AssociateName": "<string>",
    "AssociateId": 123,
    "UsePersonAddress": true,
    "ContactFax": "<string>",
    "Kanafname": "<string>",
    "Kanalname": "<string>",
    "Post1": "<string>",
    "Post2": "<string>",
    "Post3": "<string>",
    "EmailName": "<string>",
    "ContactFullName": "<string>",
    "ActiveErpLinks": 123,
    "TicketPriorityId": 123,
    "SupportLanguageId": 123,
    "SupportAssociateId": 123,
    "CategoryName": "<string>",
    "PersonNumber": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Currency": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Competitor": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Credited": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Rating": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Reason": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Source": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Status": "Unknown",
  "Saledate": "2023-11-07T05:31:56Z",
  "Amount": 123,
  "SaleId": 123,
  "Earning": 123,
  "EarningPercent": 123,
  "Heading": "<string>",
  "Number": "<string>",
  "Probability": 123,
  "CreatedDate": "2023-11-07T05:31:56Z",
  "UpdatedDate": "2023-11-07T05:31:56Z",
  "Completed": "Unknown",
  "ActiveLinks": 123,
  "Links": [
    {
      "EntityName": "<string>",
      "Id": 123,
      "Description": "<string>",
      "ExtraInfo": "<string>",
      "LinkId": 123,
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "NextDueDate": "2023-11-07T05:31:56Z",
  "Postit": "<string>",
  "SaleType": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "ReasonSold": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "ReasonStalled": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "ReopenDate": "2023-11-07T05:31:56Z",
  "SaleStakeholders": [
    {
      "StakeholderRoleName": "<string>",
      "Comment": "<string>",
      "StakeholderRoleId": 123,
      "CountryId": 123,
      "PersonId": 123,
      "EmailDescription": "<string>",
      "EmailId": 123,
      "EmailAddress": "<string>",
      "PhoneId": 123,
      "ContactName": "<string>",
      "ContactId": 123,
      "SaleId": 123,
      "Mrmrs": "<string>",
      "Firstname": "<string>",
      "MiddleName": "<string>",
      "Lastname": "<string>",
      "SaleStakeholderId": 123,
      "Rank": 123,
      "Phone": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "ActiveErpLinks": 123,
  "UserDefinedFields": {},
  "ExtraFields": {},
  "CustomFields": {},
  "PublishEventDate": "2023-11-07T05:31:56Z",
  "PublishTo": "2023-11-07T05:31:56Z",
  "PublishFrom": "2023-11-07T05:31:56Z",
  "IsPublished": true,
  "VisibleFor": [
    {
      "VisibleId": 123,
      "Visibility": "All",
      "DisplayValue": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {},
  "_Links": {}
}

Get Sale Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/Sale/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:53294/api/v1/Sale/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "53294",
  CURLOPT_URL => "http://localhost:53294/api/v1/Sale/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:53294/api/v1/Sale/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Appointment": {
    "AppointmentId": 123,
    "StartDate": "2023-11-07T05:31:56Z",
    "EndDate": "2023-11-07T05:31:56Z",
    "Type": "Unknown",
    "Task": "<string>",
    "AssociateFullName": "<string>",
    "ContactName": "<string>",
    "Description": "<string>",
    "PersonFullName": "<string>",
    "PersonId": 123,
    "ContactId": 123,
    "ProjectId": 123,
    "ProjectName": "<string>",
    "IsPublished": true,
    "AssociateId": 123,
    "ColorIndex": 123,
    "IsFree": true,
    "HasAlarm": true,
    "IsAlldayEvent": true,
    "Private": "Public",
    "PriorityId": 123,
    "PriorityName": "<string>",
    "TaskType": "Unknown",
    "IsBookingMain": true,
    "IsRecurrence": true,
    "IsBooking": true,
    "ActiveDate": "2023-11-07T05:31:56Z",
    "AssignmentStatus": "Unknown",
    "InvitationStatus": "Unknown",
    "BookingType": "Unknown",
    "Completed": "Unknown",
    "RecurringPattern": "Unknown",
    "RecurringStartDate": "2023-11-07T05:31:56Z",
    "RecurringEndDate": "2023-11-07T05:31:56Z",
    "MotherId": 123,
    "AssignedBy": 123,
    "AssignedByFullName": "<string>",
    "RejectReason": "<string>",
    "Location": "<string>",
    "AlarmLeadTime": "<string>",
    "SaleId": 123,
    "SaleName": "<string>",
    "AssociateName": "<string>",
    "CreatedDate": "2023-11-07T05:31:56Z",
    "CreatedBy": "<string>",
    "CreatedByFullName": "<string>",
    "CreatedByAssociateId": 123,
    "CautionWarning": "OK",
    "OwnedExternally": "None",
    "MotherAssociateId": 123,
    "JoinVideomeetUrl": "<string>",
    "PreferredTZLocation": 123,
    "Title": "<string>",
    "Agenda": "<string>",
    "InternalNotes": "<string>",
    "TaskId": 123,
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Associate": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "UpdatedBy": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "CreatedBy": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Contact": {
    "ContactId": 123,
    "Name": "<string>",
    "OrgNr": "<string>",
    "Department": "<string>",
    "URL": "<string>",
    "City": "<string>",
    "DirectPhone": "<string>",
    "AssociateId": 123,
    "CountryId": 123,
    "EmailAddress": "<string>",
    "Kananame": "<string>",
    "EmailAddressName": "<string>",
    "URLName": "<string>",
    "AssociateFullName": "<string>",
    "BusinessName": "<string>",
    "CategoryName": "<string>",
    "CountryName": "<string>",
    "Address": {
      "Wgs84Latitude": 123,
      "Wgs84Longitude": 123,
      "LocalizedAddress": [
        [
          {
            "Name": "<string>",
            "Value": "<string>",
            "Tooltip": "<string>",
            "Label": "<string>",
            "ValueLength": 123,
            "AddressType": "<string>",
            "TableRight": {
              "Mask": "<string>",
              "Reason": "<string>"
            },
            "FieldProperties": {}
          }
        ]
      ],
      "Street": {
        "AtypeIdx": "Unknown",
        "Address1": "<string>",
        "Address2": "<string>",
        "Address3": "<string>",
        "City": "<string>",
        "County": "<string>",
        "State": "<string>",
        "Zipcode": "<string>",
        "Formatted": "<string>"
      },
      "Postal": {
        "AtypeIdx": "Unknown",
        "Address1": "<string>",
        "Address2": "<string>",
        "Address3": "<string>",
        "City": "<string>",
        "County": "<string>",
        "State": "<string>",
        "Zipcode": "<string>",
        "Formatted": "<string>"
      },
      "Formatted": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    },
    "FormattedAddress": "<string>",
    "FullName": "<string>",
    "IsOwnerContact": true,
    "ActiveErpLinks": 123,
    "Number1": "<string>",
    "Number2": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Project": {
    "ProjectId": 123,
    "Name": "<string>",
    "Description": "<string>",
    "URL": "<string>",
    "Type": "<string>",
    "AssociateId": 123,
    "AssociateFullName": "<string>",
    "TypeId": 123,
    "Updated": "2023-11-07T05:31:56Z",
    "StatusId": 123,
    "Status": "<string>",
    "TextId": 123,
    "PublishTo": "2023-11-07T05:31:56Z",
    "PublishFrom": "2023-11-07T05:31:56Z",
    "IsPublished": true,
    "URLName": "<string>",
    "ProjectNumber": "<string>",
    "ActiveErpLinks": 123,
    "EventId": 123,
    "StartDate": "2023-11-07T05:31:56Z",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "SaleText": "<string>",
  "Person": {
    "Position": "<string>",
    "PersonId": 123,
    "Mrmrs": "<string>",
    "Firstname": "<string>",
    "Lastname": "<string>",
    "MiddleName": "<string>",
    "Title": "<string>",
    "Description": "<string>",
    "Email": "<string>",
    "FullName": "<string>",
    "DirectPhone": "<string>",
    "FormalName": "<string>",
    "CountryId": 123,
    "ContactId": 123,
    "ContactName": "<string>",
    "Retired": 123,
    "Rank": 123,
    "ActiveInterests": 123,
    "ContactDepartment": "<string>",
    "ContactCountryId": 123,
    "ContactOrgNr": "<string>",
    "FaxPhone": "<string>",
    "MobilePhone": "<string>",
    "ContactPhone": "<string>",
    "AssociateName": "<string>",
    "AssociateId": 123,
    "UsePersonAddress": true,
    "ContactFax": "<string>",
    "Kanafname": "<string>",
    "Kanalname": "<string>",
    "Post1": "<string>",
    "Post2": "<string>",
    "Post3": "<string>",
    "EmailName": "<string>",
    "ContactFullName": "<string>",
    "ActiveErpLinks": 123,
    "TicketPriorityId": 123,
    "SupportLanguageId": 123,
    "SupportAssociateId": 123,
    "CategoryName": "<string>",
    "PersonNumber": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Currency": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Competitor": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Credited": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Rating": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Reason": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Source": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Status": "Unknown",
  "Saledate": "2023-11-07T05:31:56Z",
  "Amount": 123,
  "SaleId": 123,
  "Earning": 123,
  "EarningPercent": 123,
  "Heading": "<string>",
  "Number": "<string>",
  "Probability": 123,
  "CreatedDate": "2023-11-07T05:31:56Z",
  "UpdatedDate": "2023-11-07T05:31:56Z",
  "Completed": "Unknown",
  "ActiveLinks": 123,
  "Links": [
    {
      "EntityName": "<string>",
      "Id": 123,
      "Description": "<string>",
      "ExtraInfo": "<string>",
      "LinkId": 123,
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "NextDueDate": "2023-11-07T05:31:56Z",
  "Postit": "<string>",
  "SaleType": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "ReasonSold": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "ReasonStalled": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "ReopenDate": "2023-11-07T05:31:56Z",
  "SaleStakeholders": [
    {
      "StakeholderRoleName": "<string>",
      "Comment": "<string>",
      "StakeholderRoleId": 123,
      "CountryId": 123,
      "PersonId": 123,
      "EmailDescription": "<string>",
      "EmailId": 123,
      "EmailAddress": "<string>",
      "PhoneId": 123,
      "ContactName": "<string>",
      "ContactId": 123,
      "SaleId": 123,
      "Mrmrs": "<string>",
      "Firstname": "<string>",
      "MiddleName": "<string>",
      "Lastname": "<string>",
      "SaleStakeholderId": 123,
      "Rank": 123,
      "Phone": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "ActiveErpLinks": 123,
  "UserDefinedFields": {},
  "ExtraFields": {},
  "CustomFields": {},
  "PublishEventDate": "2023-11-07T05:31:56Z",
  "PublishTo": "2023-11-07T05:31:56Z",
  "PublishFrom": "2023-11-07T05:31:56Z",
  "IsPublished": true,
  "VisibleFor": [
    {
      "VisibleId": 123,
      "Visibility": "All",
      "DisplayValue": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {},
  "_Links": {}
}

Authorizations

Authorization

string

header

required

SuperOffice username:password are passed in Base64-encoded.

You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.

Authorization

string

header

required

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.

FlowImplicit

Authorization URL: https://online.superoffice.com/login/common/oauth/authorize

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Path Parameters

integer<int32>

required

The id of the SaleEntity to return.

Query Parameters

$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.

boolean

Load foreign keys on this entity into the ExtraFields property as 'app.device.keyname'='123' pairs.

Response

SaleEntity found.

The Sale Entity contains the sale amount, currency, and sale members. Sales are linked to contacts, persons, and/or projects. SaleEntity entity with API _Links added.

Appointment

object

Simple read-only appointment data. Carrier object for Appointment. Services for the Appointment Carrier is available from the Appointment Agent.

Show child attributes

Associate

object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Show child attributes

UpdatedBy

object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Show child attributes

CreatedBy

object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Show child attributes

Contact

object

Carrier object for Contact. Services for the Contact Carrier is available from the Contact Agent.

Show child attributes

Project

object

Carrier object for Project. Services for the Project Carrier is available from the Project Agent.

Show child attributes

SaleText

string

Text describing the sale

Person

object

Carrier object for Person. Services for the Person Carrier is available from the Person Agent.

Show child attributes

Currency

object

Carrier object for Currency. Services for the Currency Carrier is available from the List Agent.

Show child attributes

Competitor

object

Carrier object for Competitor. Services for the Competitor Carrier is available from the List Agent.

Show child attributes

Credited

object

Carrier object for Credited. Services for the Credited Carrier is available from the List Agent.

Show child attributes

Rating

object

Sale Stage with probability percent. Carrier object for Rating. Services for the Rating Carrier is available from the List Agent.

Show child attributes

Reason

object

Reason for a lost sale Carrier object for Reason. Services for the Reason Carrier is available from the List Agent.

Show child attributes

Source

object

Source of a sale Carrier object for Source. Services for the Source Carrier is available from the List Agent.

Show child attributes

Status

enum<string>

The state of the Sale: Open / Sold / Lost / Stalled

Available options:

Unknown,

Open,

Sold,

Lost,

Stalled,

SaintAll

Saledate

string<date-time>

(expected / lost / won) sales date

Amount

number<double>

Total sale amount

SaleId

integer<int32>

Primary key

Earning

number<double>

Earning on sale

EarningPercent

number<double>

Earning as percent of total

Heading

string

Sale heading (short description?)

Number

string

Alphanumeric user field

Probability

integer<int32>

Actual probability, may differ from the one in the list

CreatedDate

string<date-time>

Registered date in UTC.

UpdatedDate

string<date-time>

Last updated in UTC.

Completed

enum<string>

The sale's completed state as an ActivityStatus (Completed=3), not the SaleDone enum stored in sale.done. Only Completed marks the sale as done (sale.done=2); any other value, including Started, is stored as not done (sale.done=1).

Available options:

Unknown,

NotStarted,

Started,

Completed

ActiveLinks

integer<int32>

Number of active links to sale, document, appointment.

Links

object[]

List of all elements linked to the sale.

Show child attributes

NextDueDate

string<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.

Postit

string

The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases

SaleType

object

Carrier object for SaleType. Services for the SaleType Carrier is available from the List Agent.

Show child attributes

ReasonSold

object

Reason for a succesfully sold sale Carrier object for ReasonSold. Services for the ReasonSold Carrier is available from the List Agent.

Show child attributes

ReasonStalled

object

Carrier object for ReasonStalled. Services for the ReasonStalled Carrier is available from the List Agent.

Show child attributes

ReopenDate

string<date-time>

Date the sale is to be reopened; valid only for status=stalled. Not necessarily the same as the nextDueDate.

SaleStakeholders

object[]

Show child attributes

ActiveErpLinks

integer<int32>

The number of active erp links

UserDefinedFields

object

Deprecated: Use {SuperOffice.CRM.Services.SaleEntity.CustomFields} instead. Dictionary of user defined field data. The key string is the ProgId of the UdefField, or if the ProgId is empty it is a string of the format "SuperOffice:[UdefFieldIdentity]", e.g. "SuperOffice:1234"

Show child attributes

ExtraFields

object

Deprecated: Use {SuperOffice.CRM.Services.SaleEntity.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

Show child attributes

CustomFields

object

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual {SuperOffice.CRM.Services.SaleEntity.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection.

Show child attributes

PublishEventDate

string<date-time>

Publish event date

PublishTo

string<date-time>

Publication valid to (inclusive)

PublishFrom

string<date-time>

Publication valid from (inclusive)

IsPublished

boolean

Publication is published

VisibleFor

object[]

The set of users or groups the record is visible for

Show child attributes

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes

_Links

object

Show child attributes