API

CRM APIs

GET sales/opportunities/{salesOpportunityId}

Opportunity details for provided identifier

HTTP method GET
URI https://api.rambase.net/sales/opportunities/{salesOpportunityId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {salesOpportunityId} Sales opportunity identifier
Integer, minimum 100000, default 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 2772, version 22

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<SalesOpportunity>
2
     <SalesOpportunityId
SalesOpportunityId

Sales opportunity identifier

>{Integer}</SalesOpportunityId>
3
     <Status
Status

The current status of an opportunity.

Possible domain values can be found here

>{Integer}</Status>
4
     <Title
Title

The title of the opportunity

>{String}</Title>
5
     <Source
Source

The source of this Opportunity/lead (website, conference, marketing campaign....)

Possible domain values can be found here

>{Integer}</Source>
6
     <ExpectedCloseDate
ExpectedCloseDate

The date when you expect the deal to be closed.

>{Date}</ExpectedCloseDate>
7
     <Probability
Probability

The probability of winning this opportunity in percentage.

>{Integer}</Probability>
8
     <OpportunityStageChangedAt
OpportunityStageChangedAt

The date the opportunity entered the stage

>{Datetime}</OpportunityStageChangedAt>
9
     <OpportunityStatusChangedDate
OpportunityStatusChangedDate

The date when the status was last changed

>{Date}</OpportunityStatusChangedDate>
10
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
11
     <Value>
12
          <Currency
Currency

Currencies used by the customer

Possible domain values can be found here

>{String}</Currency>
13
          <UnweightedAmount
UnweightedAmount

The unweighted value of this opportunity (amount)

>{Integer}</UnweightedAmount>
14
          <WeightedAmount
WeightedAmount

The value of this opportunity weighted against the probability

>{Integer}</WeightedAmount>
15
          <OneTimeRevenueAmount
OneTimeRevenueAmount

The value of startup/creation of the opportunity

>{Integer}</OneTimeRevenueAmount>
16
          <RecurringRevenueAmount
RecurringRevenueAmount

Monthly reccuring value of the opportunity

>{Integer}</RecurringRevenueAmount>
17
          <ContractMonths
ContractMonths

Number of months with recurring value

>{Integer}</ContractMonths>
18
     </Value>
19
     <Contact
Contact

Contact reference

>
20
          <ContactId
ContactId

Contact identifier

>{Integer}</ContactId>
21
          <FirstName
FirstName

Firstname/givenname of the contact

>{String}</FirstName>
22
          <LastName
LastName

Surname/familyname/lastname of the contact

>{String}</LastName>
23
          <ContactLink
ContactLink

Contact reference

>{String}</ContactLink>
24
     </Contact>
25
     <Customer
Customer

Customer reference

>
26
          <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
27
          <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>{String}</Name>
28
          <FirstName
FirstName

Secondary name of a company or firstname of a person

>{String}</FirstName>
29
          <Phone
Phone

Customers main phone number

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Phone in your request URI to get this field

>{String}</Phone>
30
          <Email
Email

Customers main email

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Email in your request URI to get this field

>{String}</Email>
31
          <Sales>
32
               <SalesDistrict
SalesDistrict

A geographic district for which an individual salesperson or sales team holds responsibility

Possible domain values can be found here

>{String}</SalesDistrict>
33
               <MarketSegment
MarketSegment

Market segment of the customer

Possible domain values can be found here

>{String}</MarketSegment>
34
          </Sales>
35
          <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
36
     </Customer>
37
     <Owner
Owner

PID reference to the owner of the opportunity

>
38
          <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
39
          <LastName
LastName

Last name of employee

>{String}</LastName>
40
          <FirstName
FirstName

First name of employee

>{String}</FirstName>
41
          <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
42
     </Owner>
43
     <Assignee
Assignee

The employee the opportunity is assigned to.

>
44
          <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
45
          <LastName
LastName

Last name of employee

>{String}</LastName>
46
          <FirstName
FirstName

First name of employee

>{String}</FirstName>
47
          <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
48
     </Assignee>
49
     <OpportunityStage
OpportunityStage

The stage this opportunity is currently in.

>
50
          <OpportunityStageId
OpportunityStageId

Opportunity stage identifier

>{Integer}</OpportunityStageId>
51
          <Name
Name

The name of the stage

>{String}</Name>
52
          <Probability
Probability

The probability of winning the opportunity when it is in this stage. In percentage.

>{Integer}</Probability>
53
          <DaysBeforeWarning
DaysBeforeWarning

The number of days the opportunity can stay in this stage without causing a warning.

>{Integer}</DaysBeforeWarning>
54
          <OpportunityStageLink
OpportunityStageLink

Opportunity stage reference

>{String}</OpportunityStageLink>
55
     </OpportunityStage>
56
</SalesOpportunity>
1
{
2
     "salesOpportunity": {
3
          "salesOpportunityId
SalesOpportunityId

Sales opportunity identifier

": "{Integer}",
4
          "status
Status

The current status of an opportunity.

Possible domain values can be found here

": "{Integer}",
5
          "title
Title

The title of the opportunity

": "{String}",
6
          "source
Source

The source of this Opportunity/lead (website, conference, marketing campaign....)

Possible domain values can be found here

": "{Integer}",
7
          "expectedCloseDate
ExpectedCloseDate

The date when you expect the deal to be closed.

": "{Date}",
8
          "probability
Probability

The probability of winning this opportunity in percentage.

": "{Integer}",
9
          "opportunityStageChangedAt
OpportunityStageChangedAt

The date the opportunity entered the stage

": "{Datetime}",
10
          "opportunityStatusChangedDate
OpportunityStatusChangedDate

The date when the status was last changed

": "{Date}",
11
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
12
          "value": {
13
               "currency
Currency

Currencies used by the customer

Possible domain values can be found here

": "{String}",
14
               "unweightedAmount
UnweightedAmount

The unweighted value of this opportunity (amount)

": "{Integer}",
15
               "weightedAmount
WeightedAmount

The value of this opportunity weighted against the probability

": "{Integer}",
16
               "oneTimeRevenueAmount
OneTimeRevenueAmount

The value of startup/creation of the opportunity

": "{Integer}",
17
               "recurringRevenueAmount
RecurringRevenueAmount

Monthly reccuring value of the opportunity

": "{Integer}",
18
               "contractMonths
ContractMonths

Number of months with recurring value

": "{Integer}"
19
          },
20
          "contact
Contact

Contact reference

": {
21
               "contactId
ContactId

Contact identifier

": "{Integer}",
22
               "firstName
FirstName

Firstname/givenname of the contact

": "{String}",
23
               "lastName
LastName

Surname/familyname/lastname of the contact

": "{String}",
24
               "contactLink
ContactLink

Contact reference

": "{String}"
25
          },
26
          "customer
Customer

Customer reference

": {
27
               "customerId
CustomerId

Customer identifier

": "{Integer}",
28
               "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

": "{String}",
29
               "firstName
FirstName

Secondary name of a company or firstname of a person

": "{String}",
30
               "phone
Phone

Customers main phone number

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Phone in your request URI to get this field

": "{String}",
31
               "email
Email

Customers main email

This field is greyed out because it is an expandable field. You have to add $expand=Customer.Email in your request URI to get this field

": "{String}",
32
               "sales": {
33
                    "salesDistrict
SalesDistrict

A geographic district for which an individual salesperson or sales team holds responsibility

Possible domain values can be found here

": "{String}",
34
                    "marketSegment
MarketSegment

Market segment of the customer

Possible domain values can be found here

": "{String}"
35
               },
36
               "customerLink
CustomerLink

Customer reference

": "{String}"
37
          },
38
          "owner
Owner

PID reference to the owner of the opportunity

": {
39
               "employeeId
EmployeeId

Employee identifier

": "{Integer}",
40
               "lastName
LastName

Last name of employee

": "{String}",
41
               "firstName
FirstName

First name of employee

": "{String}",
42
               "employeeLink
EmployeeLink

Employee reference

": "{String}"
43
          },
44
          "assignee
Assignee

The employee the opportunity is assigned to.

": {
45
               "employeeId
EmployeeId

Employee identifier

": "{Integer}",
46
               "lastName
LastName

Last name of employee

": "{String}",
47
               "firstName
FirstName

First name of employee

": "{String}",
48
               "employeeLink
EmployeeLink

Employee reference

": "{String}"
49
          },
50
          "opportunityStage
OpportunityStage

The stage this opportunity is currently in.

": {
51
               "opportunityStageId
OpportunityStageId

Opportunity stage identifier

": "{Integer}",
52
               "name
Name

The name of the stage

": "{String}",
53
               "probability
Probability

The probability of winning the opportunity when it is in this stage. In percentage.

": "{Integer}",
54
               "daysBeforeWarning
DaysBeforeWarning

The number of days the opportunity can stay in this stage without causing a warning.

": "{Integer}",
55
               "opportunityStageLink
OpportunityStageLink

Opportunity stage reference

": "{String}"
56
          }
57
     }
58
}

Possible error codes the response might return:

Error 102738 HTTP 404 Price list not found
Error 100055 HTTP 403 You have only admittance to your own objects