Please enable JavaScript to view this site.

Error itgendoc001X

xMsg javascript has not been loaded.

Simplicate API Data Model

Navigation: Schema: Sales > Tables

SalesById

 Contents Previous Home Next More

Fetches a single sales by id

Catalog: Simplicate

Schema: Sales

This is a read-only table function. The Simplicate API may not support changing the data or the Invantive SQL driver for Simplicate does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Simplicate API.

Select Simplicate API URL: /sales/sales/{id}

Insert Simplicate API URL: /sales/sales/{id}

Update Simplicate API URL: /sales/sales/{id}

Delete Simplicate API URL: /sales/sales/{id}

Field Selection Method: NotRequired

Base Path: data

Select Simplicate API Operation: get /sales/sales/{id}

Table Function Parameters

The following parameters can be used to control the behaviour of the table function SalesById. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

id

string

☑

 

The template's id

 

Table Function Columns

The columns of the table function SalesById are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

chance_to_score

string

 

☐

 

contact_family_name_prefix

string

 

☐

 

contact_family_name

string

 

☐

 

contact_first_name

string

 

☐

 

contact_id_1

string

 

☐

 

contact_id

string

 

☐

 

contact_person_id

string

 

☐

 

contact_work_email

string

 

☐

 

contact_work_function

string

 

☐

 

contact_work_mobile

string

 

☐

 

contact_work_phone

string

 

☐

 

created_at

string

Created at

☐

 

created

string

Created

☐

 

expected_closing_date

string

 

☐

 

expected_revenue

float

 

☐

 

id

string

ID

☐

 

lost_to_competitor_id

string

 

☐

 

lost_to_competitor_name

string

 

☐

 

modified

string

Modified

☐

 

my_organization_profile_id

string

 

☐

 

note

string

Note

☐

 

organization_id_1

string

 

☐

 

organization_id

string

Organization ID

☐

 

organization_name

string

Organization Name

☐

 

person_full_name

string

 

☐

 

person_id_1

string

 

☐

 

person_id

string

Person ID

☐

 

progress_chance_to_score

float

 

☐

 

progress_color

string

 

☐

 

progress_id

string

 

☐

 

progress_label

string

 

☐

 

progress_position

int64

 

☐

 

reason_id

string

 

☐

 

reason_name

string

 

☐

 

responsible_employee_amount

float

 

☐

 

responsible_employee_declarable

string

 

☐

 

responsible_employee_employee_id

string

 

☐

 

responsible_employee_id

string

 

☐

 

responsible_employee_name

string

 

☐

 

responsible_employee_person_id

string

 

☐

 

responsible_employee_tariff

float

 

☐

 

separate_invoice_recipient_contact_id

string

 

☐

 

separate_invoice_recipient_contact_organization_id

string

 

☐

 

separate_invoice_recipient_contact_organization_name

string

 

☐

 

separate_invoice_recipient_contact_person_full_name

string

 

☐

 

separate_invoice_recipient_contact_person_id

string

 

☐

 

separate_invoice_recipient_is_separate_invoice_recipient

boolean

 

☐

 

separate_invoice_recipient_organization_id

string

 

☐

 

separate_invoice_recipient_organization_name

string

 

☐

 

separate_invoice_recipient_person_full_name

string

 

☐

 

separate_invoice_recipient_person_id

string

 

☐

 

simplicate_url

string

Simplicate URL

☐

 

source_id

string

 

☐

 

source_name

string

 

☐

 

start_date

string

Start Date

☐

 

status_id

string

 

☐

 

status_label

string

 

☐

 

status_updated_at

string

 

☐

 

subject

string

 

☐

 

timeline_email_address

string

 

☐

 

updated_at

string

Updated at

☐

 

 

06-04-2021 14:59 Version 20.1.393-BETA+3152