Synapcus Developers (EN)

Opportunity (sop)

The entity sale opportunity represents a specific external project request (a project in the acquisition phase) or the initiation of a business relationship before a specific assignment is made, as well as an idea for product development that becomes an internal project after approval. 

Database level

The entity's attributes are shown below. Mandatory fields are marked with a red star:

Name

Type

Label

Description

form *

string

Form

Represents the entity form. Will always be "sop".

sop_name *

string

Name

The object name - max. length of 128 characters.

sop_chance *

Number

Chance

Represents the chance of successfully closing the opportunity into a project based on the sales process phases. For further details please visit our online help. 

sop_nr *

String


Represents the opportunity's number. Will always be "S-YYxxxx" as serial number, that automatically increments by 1 as each new record is added. (e.g. "S-190007" represents the 7th Opportunity within year 2019).

sop_org_names *

String


Represents the name of the organisation for whom the opportunity was created.

sop_org_unid *

String


Represents the unique ID of the organisation document for whom the opportunity was created.

sop_resp_name *

String


Represents the name of the person responsible for the opportunity.

sop_resp_unid *

String


Represents the unique ID of the person document responsible for the opportunity.

sop_start *

Date/Time


Beginning date of the opportunity.

sop_end *

Date/Time


Expected date the decision to be taken for the opportunity.

sop_state

Number


Represents the status of the opportunity as a number. Will be one of {100, 200}

sop_state_text

String


Represents the status of the opportunity as text. Will be one of {open, closed}

sop_complete

String


If completed, then "1".

sop_complete_date

Date/Time


e.g. 05.11.2019 16:12:59 CET

sop_complete_reason

String


Specifies the reason an opportunity has been successfully closed, or why lost. 

sop_complete_text

String


Specifies if an opportunity has been successfully closed, or why lost. 

sop_cost_material

Number


Represents the total cost for material during the aqkuision. 

sop_cost_misc

Number


Represents the total cost for other expences during the aqkuision. 

sop_cost_total

Number


Represents the total cost during the aqkuision as a sum of all cost-categories. 

sop_cost_travel

Number


Represents the total cost for travels during the aqkuision. 

sop_cost_work

Number


Represents the total cost for label during the aqkuision. 

sop_desc

HTML-String


The description of what is the opportunity about. can incloud tesx, pictures, tables, links aso.

sop_industry

String


The industry the potential customer belongs to.

sop_invs_open_value

Number


The open (unpaid) value of the issued invoices.

sop_invs_payed_value

Number


The paid value of the issued invoices.

sop_ords_rest_value

Number


The rest ordered value which hasn't been jet billed. 

sop_midd_name

String


Represents the contact name of the person who mediates the business.

sop_midd_unid

Number


Represents the unique ID of the contact document of the person who mediates the business.

sop_persops_unid

Strings Array 


A list of the unique IDs of the person documents of the participators in this opportunity.

sop_plan_add

Number


Negotiated additional fee as a percentage.

sop_plan_mp

Number


Negotiated general planner surcharge as a percentage.

sop_retain

Number


Retention as percent.

sop_sales_actual

Number


The actual sales revenue based on confirmed orders.

sop_sales_expected

Number


The expected sales revenue based on provided offers. 

sop_sales_profit_actual

Number


The actual profit based on confirmed orders.

sop_sales_profit_expected

Number


The expected profit based on provided offers.

sop_sales_subs_actual

Number


The actual sales revenue for subcontracters based on confirmed orders.

sop_sales_subs_expected

Number


The expected sales revenue for subcontracters based on provided offers. 

sop_sales_total_actual

Number


The actual total sales revenue including subcontracters based on confirmed orders.

sop_sales_total_expected

Number


The expected total sales revenue including subcontracters based on provided offers. 

sop_sof

Time/Date 


 e.g. 20.02.2020 12:00:00 CET

sop_sofs_open

Number


Represents the total value of open offers. 

QEE classes level

The class representing the Opportunity is QEESop

Inherits from: QEEObject

REST level

The endpoints dealing with Opportunity are:

xrSop (GET, POST, PUT, DELETE)

xrSops (GET, PUT, DELETE)