Error itgendoc001X
xMsg javascript has not been loaded.
Simplicate API Data ModelFetches a single invoice by id
Catalog: Simplicate
Schema: Invoices
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: /invoices/invoice/{id}
Insert Simplicate API URL: /invoices/invoice/{id}
Update Simplicate API URL: /invoices/invoice/{id}
Delete Simplicate API URL: /invoices/invoice/{id}
Field Selection Method: NotRequired
Base Path: data
Select Simplicate API Operation: get /invoices/invoice/{id}
Table Function Parameters
The following parameters can be used to control the behaviour of the table function InvoiceById. 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 InvoiceById are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
comments |
string |
|
☐ |
|
composition_type |
string |
|
☐ |
|
contact_id |
string |
|
☐ |
|
created_at |
string |
Created at |
☐ |
|
created |
string |
Created |
☐ |
|
date |
string |
|
☐ |
|
id |
string |
ID |
☐ |
|
invoice_number |
string |
|
☐ |
|
my_organization_profile_id_1 |
string |
|
☐ |
|
my_organization_profile_id |
string |
|
☐ |
|
my_organization_profile_organization_id |
string |
|
☐ |
|
my_organization_profile_organization_name |
string |
|
☐ |
|
organization_id_1 |
string |
|
☐ |
|
organization_id |
string |
Organization ID |
☐ |
|
organization_name |
string |
Organization Name |
☐ |
|
payment_term_days |
int64 |
|
☐ |
|
payment_term_id |
string |
|
☐ |
|
payment_term_method |
string |
|
☐ |
|
payment_term_name |
string |
|
☐ |
|
person_full_name |
string |
|
☐ |
|
person_id_1 |
string |
|
☐ |
|
person_id |
string |
Person ID |
☐ |
|
project_id_1 |
string |
|
☐ |
|
project_id |
string |
Project ID |
☐ |
|
project_name |
string |
|
☐ |
|
project_organization_id |
string |
|
☐ |
|
project_organization_name |
string |
|
☐ |
|
project_person_full_name |
string |
|
☐ |
|
project_person_id |
string |
|
☐ |
|
project_project_manager_amount |
float |
|
☐ |
|
project_project_manager_declarable |
string |
|
☐ |
|
project_project_manager_employee_id |
string |
|
☐ |
|
project_project_manager_id |
string |
|
☐ |
|
project_project_manager_name |
string |
|
☐ |
|
project_project_manager_person_id |
string |
|
☐ |
|
project_project_manager_tariff |
float |
|
☐ |
|
project_project_number |
string |
|
☐ |
|
project_separate_invoice_recipient_contact_id |
string |
|
☐ |
See 'linked_persons_contact' in /crm/organization, or 'linked_as_contact_to_organization' in /crm/person, or /crm/contactperson |
project_separate_invoice_recipient_is_separate_invoice_recipient |
boolean |
|
☐ |
|
project_separate_invoice_recipient_organization_id |
string |
|
☐ |
See /crm/organization |
project_separate_invoice_recipient_person_id |
string |
|
☐ |
See /crm/person |
reference |
string |
|
☐ |
|
reminder_next_action |
string |
|
☐ |
|
reminder_paused |
boolean |
|
☐ |
|
reminder_set_disabled |
boolean |
|
☐ |
|
reminder_set_id |
string |
|
☐ |
|
reminder_set_label |
string |
|
☐ |
|
sending_method |
string |
|
☐ |
|
simplicate_url |
string |
Simplicate URL |
☐ |
|
status_color |
string |
|
☐ |
|
status_id |
string |
|
☐ |
|
status_name |
string |
|
☐ |
|
subject |
string |
|
☐ |
|
subscription_cycle_end_date |
string |
|
☐ |
|
subscription_cycle_is_invoiced |
boolean |
|
☐ |
|
subscription_cycle_start_date |
string |
|
☐ |
|
timeline_email_address |
string |
|
☐ |
|
total_excluding_vat |
float |
|
☐ |
|
total_including_vat |
float |
|
☐ |
|
total_outstanding |
float |
|
☐ |
|
total_vat |
float |
|
☐ |
|
updated_at |
string |
Updated at |
☐ |
|
06-04-2021 14:59 Version 20.1.393-BETA+3152
