Please enable JavaScript to view this site.

Error itgendoc001X

xMsg javascript has not been loaded.

Simplicate API Data Model

Navigation: Schema: Projects > Tables

ProjectById

 Contents Previous Home Next More

Fetches a single project by id

Catalog: Simplicate

Schema: Projects

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: /projects/project/{id}

Insert Simplicate API URL: /projects/project/{id}

Update Simplicate API URL: /projects/project/{id}

Delete Simplicate API URL: /projects/project/{id}

Field Selection Method: NotRequired

Base Path: data

Select Simplicate API Operation: get /projects/project/{id}

Table Function Parameters

The following parameters can be used to control the behaviour of the table function ProjectById. 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 ProjectById are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

abnormal_address

boolean

 

☐

 

abnormal_contact_id

string

 

☐

 

abnormal_organization_id

string

 

☐

 

abnormal_person_id

string

 

☐

 

billable

boolean

 

☐

 

budget_costs_value_budget

float

 

☐

 

budget_costs_value_spent

float

 

☐

 

budget_hours_amount_budget

float

 

☐

 

budget_hours_amount_spent

float

 

☐

 

budget_hours_value_budget

float

 

☐

 

budget_hours_value_spent

float

 

☐

 

budget_total_value_budget

float

 

☐

 

budget_total_value_invoiced

float

 

☐

 

budget_total_value_spent

float

 

☐

 

can_register_mileage

boolean

 

☐

 

contact_id_1

string

 

☐

 

contact_id

string

 

☐

 

contact_organization_id

string

 

☐

 

contact_organization_name

string

 

☐

 

contact_person_full_name

string

 

☐

 

contact_person_id

string

 

☐

 

created_at

string

Created at

☐

 

created

string

Created

☐

 

divergent_payment_term_days

int64

 

☐

 

divergent_payment_term_id

string

 

☐

 

divergent_payment_term_method

string

 

☐

 

divergent_payment_term_name

string

 

☐

 

end_date

string

End Date

☐

 

hours_rate_type

string

 

☐

 

id

string

ID

☐

 

invoice_reference

string

 

☐

 

is_invoice_approval

boolean

 

☐

 

is_reverse_billing

boolean

 

☐

 

modified

string

Modified

☐

 

my_organization_profile_id_1

string

 

☐

 

my_organization_profile_id

string

 

☐

 

my_organization_profile_organization_id

string

 

☐

 

my_organization_profile_organization_name

string

 

☐

 

name

string

Name

☐

 

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

☐

 

project_manager_amount

float

 

☐

 

project_manager_declarable

string

 

☐

 

project_manager_employee_id

string

 

☐

 

project_manager_id

string

 

☐

 

project_manager_name

string

 

☐

 

project_manager_person_id

string

 

☐

 

project_manager_tariff

float

 

☐

 

project_number

string

 

☐

 

project_status_color

string

 

☐

 

project_status_id

string

 

☐

 

project_status_label

string

 

☐

 

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

☐

 

start_date

string

Start Date

☐

 

timeline_email_address

string

 

☐

 

updated_at

string

Updated at

☐

 

 

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