Connectors Reference
Import, export and transform your Business Central data
|
Status: Preview |
Tier: Premium |
Version: 2.0 |
|
Name |
Summary |
|
RecordCreated (string Environment, string Company, RecordCreatedParameterBody body) |
Triggers when a record is created |
|
RecordDeleted (string Environment, string Company, RecordDeletedParameterBody body) |
Triggers when a record is deleted |
|
RecordUpdated (string Environment, string Company, RecordUpdatedParameterBody body) |
Triggers when a record is updated |
|
RecordCreatedV2 (string Environment, string Company, RecordCreatedV2ParameterBody body) |
Triggers when a record is created (V2) |
|
RecordDeletedV2 (string Environment, string Company, RecordDeletedV2ParameterBody body) |
Triggers when a record is deleted (V2) |
|
RecordUpdatedV2 (string Environment, string Company, RecordUpdatedV2ParameterBody body) |
Triggers when a record is updated (V2) |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
Request |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Response |
|
|
|
|
|
Response |
|
|
Response |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Request |
|
|
Request |
|
|
Request |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Request |
|
|
|
Summary: Get Csv
Description: Get data based on passed configuration and returns the data in the CSV format set in the configuration
Syntax:
Connect2All.GetCsvDocument (string Environment, string Company, string Configuration, [advanced][Optional]string delimiter, [advanced][Optional]boolean headers)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Configuration |
string (Configuration) |
The configuration to use to transform the data to and from Business Central |
True |
|
|
delimiter |
string (Delimiter) |
The delimiter to be used to seperate the columns |
False |
|
|
headers |
boolean (Use Headers) |
If set headers are used in the CSV |
False |
Returns:
Summary: Process Csv
Description: Imports and transforms CSV into Business Central data using a specific configuration
Syntax:
Connect2All.PostTransformCsv (string Environment, string Company, string Configuration, PostTransformCsvParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Configuration |
string (Configuration) |
The configuration to use to transform the data to and from Business Central |
True |
|
|
body |
|
|
True |
Returns:
Summary: Get Csv with metadata
Description: Get data with metadata based on passed configuration and returns the data in the CSV format set in the configuration
Syntax:
Connect2All.GetCsvDocumentWithMetadata (string Environment, string Company, string Configuration, [advanced][Optional]string delimiter, [advanced][Optional]boolean headers)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Configuration |
string (Configuration) |
The configuration to use to transform the data to and from Business Central |
True |
|
|
delimiter |
string (Delimiter) |
The delimiter to be used to seperate the columns |
False |
|
|
headers |
boolean (Use Headers) |
If set headers are used in the CSV |
False |
Returns:
Type:GetCsvDocumentWithMetadataResponse
Summary: Get Csv by Id with metadata
Description: Get data by Id with metadata based on passed configuration and returns the data in the CSV format set in the configuration
Syntax:
Connect2All.GetCsvDocumentByIdWithMetadata (string Environment, string Company, string Configuration, string SystemId, [advanced][Optional]string delimiter, [advanced][Optional]boolean headers)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Configuration |
string (Configuration) |
The configuration to use to transform the data to and from Business Central |
True |
|
|
SystemId |
string (System Id) |
The id of the record in Business Central |
True |
|
|
delimiter |
string (Delimiter) |
The delimiter to be used to seperate the columns |
False |
|
|
headers |
boolean (Use Headers) |
If set headers are used in the CSV |
False |
Returns:
Type:GetCsvDocumentByIdWithMetadataResponse
Summary: Get Csv by Id
Description: Get data by SystemId based on passed configuration and returns the data in the CSV format set in the configuration
Syntax:
Connect2All.GetCsvDocumentById (string Environment, string Company, string Configuration, string SystemId, [advanced][Optional]string delimiter, [advanced][Optional]boolean headers)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Configuration |
string (Configuration) |
The configuration to use to transform the data to and from Business Central |
True |
|
|
SystemId |
string (System Id) |
The id of the record in Business Central |
True |
|
|
delimiter |
string (Delimiter) |
The delimiter to be used to seperate the columns |
False |
|
|
headers |
boolean (Use Headers) |
If set headers are used in the CSV |
False |
Returns:
Type:GetCsvDocumentByIdResponse
Summary: Get Xml
Description: Get data based on passed configuration and returns the data in the XML format set in the configuration
Syntax:
Connect2All.GetXmlDocument (string Environment, string Company, string Configuration)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Configuration |
string (Configuration) |
The configuration to use to transform the data to and from Business Central |
True |
Returns:
Summary: Process Xml
Description: Imports and transforms XML into Business Central data using a specific configuration
Syntax:
Connect2All.PostTransformXml (string Environment, string Company, string Configuration, PostTransformXmlParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Configuration |
string (Configuration) |
The configuration to use to transform the data to and from Business Central |
True |
|
|
body |
|
|
True |
Returns:
Summary: Get Xml with metadata
Description: Get data with metadata based on passed configuration and returns the data in the XML format set in the configuration
Syntax:
Connect2All.GetXmlDocumentWithMetadata (string Environment, string Company, string Configuration)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Configuration |
string (Configuration) |
The configuration to use to transform the data to and from Business Central |
True |
Returns:
Type:GetXmlDocumentWithMetadataResponse
Summary: Get Xml by Id with metadata
Description: Get data by Id with metadata based on passed configuration and returns the data in the XML format set in the configuration
Syntax:
Connect2All.GetXmlDocumentByIdWithMetadata (string Environment, string Company, string Configuration, string SystemId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Configuration |
string (Configuration) |
The configuration to use to transform the data to and from Business Central |
True |
|
|
SystemId |
string (System Id) |
The id of the record in Business Central |
True |
Returns:
Type:GetXmlDocumentByIdWithMetadataResponse
Summary: Get Xml by Id
Description: Get data by SystemId based on passed configuration and returns the data in the XML format set in the configuration
Syntax:
Connect2All.GetXmlDocumentById (string Environment, string Company, string Configuration, string SystemId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Configuration |
string (Configuration) |
The configuration to use to transform the data to and from Business Central |
True |
|
|
SystemId |
string (System Id) |
The id of the record in Business Central |
True |
Returns:
Type:GetXmlDocumentByIdResponse
Summary: GetActions
Description: Get a list of all available actions in Business Central
Syntax:
Connect2All.GetActions (string Environment, string Company)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
Returns:
Type:array of (GetActionsResponseItem)
Summary: Perform an action
Description: Schedule to perform an action in Business Central
Syntax:
Connect2All.PerformAction (string Environment, string Company, PerformActionRequest body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
body |
|
|
True |
Returns:
Summary: Get Companies
Description: Get a list of companies from Business Central
Syntax:
Connect2All.GetCompanies (string Environment)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
Returns:
Type:array of (string)
Summary: Get Configurations for data transformation
Description: Get Configurations from Business Central for data transformation
Syntax:
Connect2All.GetConfigurationNames (string Environment, string Company)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
Returns:
Type:array of (string)
Summary: Get Environments
Description: Get a list of available Business Central environments
Syntax:
Connect2All.GetEnvironments ()
Returns:
Type:array of (string)
Summary: Delete Data
Description: Delete data from Business Central by it's unique id
Syntax:
Connect2All.DeleteData (string Environment, string Company, integer Table, string SystemId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Table |
integer(int32) (Table) |
The table in Business Central to retrieve data from |
True |
|
|
SystemId |
string (System Id) |
The id of the record in Business Central |
True |
Returns:
Summary: Get Data
Description: Get data from Business Central for specific tables
Syntax:
Connect2All.GetData (string Environment, string Company, [advanced][Optional]string Language, ReadRequest body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Language |
string (Language) |
The language in which to communicate with Business Central |
False |
|
|
body |
(Request) |
The request to retrieve data |
True |
Returns:
Type:GetDataResponseResponse
Title: Response
Summary: Response
Description: Response
Summary: Get Data (Complex)
Description: Get data from Business Central with a raw JSON request
Syntax:
Connect2All.GetDataRaw (string Environment, string Company, [advanced][Optional]string Language, GetDataRawParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Language |
string (Language) |
The language in which to communicate with Business Central |
False |
|
|
body |
|
|
True |
Returns:
Type:GetDataRawResponseResponse
Title: Response
Summary: Response
Description: Response
Summary: Get Data by Id
Description: Get data from Business Central for a specific table and record
Syntax:
Connect2All.GetDataById (string Environment, string Company, [advanced][Optional]string Language, ReadRequestSimple body, string SystemId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Language |
string (Language) |
The language in which to communicate with Business Central |
False |
|
|
body |
(Request) |
The request to retrieve data |
True |
|
|
SystemId |
string (System Id) |
The id of the record in Business Central |
True |
Returns:
Type:GetDataByIdResponseResponse
Title: Response
Summary: Response
Description: Response
Summary: Insert Data
Description: Insert data into a specific Business Central table
Syntax:
Connect2All.CreateData (string Environment, string Company, [advanced][Optional]string Language, CreateRequest body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Language |
string (Language) |
The language in which to communicate with Business Central |
False |
|
|
body |
(Request) |
The request to insert data |
True |
Returns:
Type:CreateDataResponseResponse
Title: Response
Summary: Insert Data (Complex)
Description: Insert data into a specific Business Central table
Syntax:
Connect2All.CreateDataComplex (string Environment, string Company, [advanced][Optional]string Language, CreateDataComplexParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Language |
string (Language) |
The language in which to communicate with Business Central |
False |
|
|
body |
CreateDataComplexParameterBody
|
|
True |
Returns:
Type:CreateDataComplexResponseResponse
Title: Response
Summary: Update Data
Description: Update a record in Business Central for a specific table
Syntax:
Connect2All.UpdateData (string Environment, string Company, [advanced][Optional]string Language, UpdateRequest body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Language |
string (Language) |
The language in which to communicate with Business Central |
False |
|
|
body |
(Request) |
The request to insert data |
True |
Returns:
Summary: Deletes a registration webhook from the Business Central environment
Description: Deletes a webhook,
Syntax:
Connect2All.DeleteTrigger (string environment, string company, string Id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
environment |
string
|
|
True |
|
|
company |
string
|
|
True |
|
|
Id |
string
|
The id of the registered webhook |
True |
Returns:
Summary: Get Languages
Description: Get a list of available languages from Business Central
Syntax:
Connect2All.GetLanguages (string Environment, string Company)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
Returns:
Type:array of (GetLanguagesResponseItem)
Summary: Delete Media
Description: Deletes the media attached to a field in Business Central
Syntax:
Connect2All.ClearMedia (string Environment, string Company, integer Table, integer Field, string SystemId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Table |
integer(int32) (Table) |
The table in Business Central to retrieve data from |
True |
|
|
Field |
integer(int32) (Field) |
A field from the selected table |
True |
|
|
SystemId |
string (System Id) |
The id of the record in Business Central |
True |
Returns:
Type:ClearMediaResponse
Summary: Get Media
Description: Retrieves a file from Business Central by it's Id
Syntax:
Connect2All.GetMedia (string Environment, string Company, integer Table, integer Field, string SystemId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Table |
integer(int32) (Table) |
The table in Business Central to retrieve data from |
True |
|
|
Field |
integer(int32) (Field) |
A field from the selected table |
True |
|
|
SystemId |
string (System Id) |
The id of the record in Business Central |
True |
Returns:
Type:GetMediaResponse
Summary: Update Media
Description: Updates a file in Business Central by it's Id
Syntax:
Connect2All.PatchMedia ([internal]string Content-Type, string Environment, string Company, integer Table, integer Field, string SystemId, string FileContent)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string (Content-Type) |
|
True |
|
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Table |
integer(int32) (Table) |
The table in Business Central to retrieve data from |
True |
|
|
Field |
integer(int32) (Field) |
A field from the selected table |
True |
|
|
SystemId |
string (System Id) |
The id of the record in Business Central |
True |
|
|
FileContent |
string(binary)
|
|
True |
Returns:
Type:PatchMediaResponse
Summary: GetReports
Description: Get a list of all available reports in Business Central
Syntax:
Connect2All.GetReports (string Environment, string Company)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
Returns:
Type:array of (GetActionsResponseItem)
Summary: Get Report
Description: Gets a report from Business Central on a report ID or a record
Syntax:
Connect2All.GetReport (string Environment, string Company, [advanced][Optional]string Language, string Format, integer ReportId, [advanced][Optional]integer TableId, [advanced][Optional]string SystemId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Language |
string (Language) |
The language in which to communicate with Business Central |
False |
|
|
Format |
string (Format)Values: [Excel, Html, Pdf, Word, Xml] |
The file format to get the report in |
True |
|
|
ReportId |
integer (Report) |
The id of the report in Business Central to retrieve |
True |
|
|
TableId |
integer(int32) (Table) |
The table in Business Central to retrieve data from |
False |
|
|
SystemId |
string (System Id) |
The id of the record in Business Central |
False |
Returns:
Type:GetReportResponse
Summary: Get schema
Description: Get schema for readrequest
Syntax:
Connect2All.GetReadRequestSchema (string Environment, string Company, GetReadRequestSchemaParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
body |
GetReadRequestSchemaParameterBody
|
|
True |
Returns:
Type:GetReadRequestSchemaResponse
Description: The schema for this read request
Summary: Get schema
Description: Get schema for readrequest by id
Syntax:
Connect2All.GetReadRequestByIdSchema (string Environment, string Company, ReadRequestSimpleSchema body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
body |
(Request) |
The request to retrieve data |
True |
Returns:
Type:GetReadRequestByIdSchemaResponse
Description: The schema for this read request
Summary: Get schema
Description: Get schema for readrequest
Syntax:
Connect2All.GetReadRequestByIdSchemaForId (string Environment, string Company, string SystemId, ReadRequestSimpleSchema body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
SystemId |
string (System Id) |
The id of the record in Business Central |
True |
|
|
body |
(Request) |
The request to retrieve data |
True |
Returns:
Type:GetReadRequestByIdSchemaForIdResponse
Description: The schema for this read request
Summary: Get schema for webhook
Description: Gets a schema for a webhook response
Syntax:
Connect2All.GetWebhookRequestSchema (string Environment, string Company, WebhookSchemaRequest body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
body |
|
|
True |
Returns:
Type:GetWebhookRequestSchemaResponse
Description: The schema for this webhook
Summary: Get Tables
Description: Get a list of available tables in Business Central
Syntax:
Connect2All.GetTables (string Environment, string Company)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
Returns:
Type:array of (GetActionsResponseItem)
Summary: Get the fields of a table
Description: Get the fields of a table in Business Central
Syntax:
Connect2All.GetFields (string Environment, string Company, integer Table, [advanced][Optional]string $contains, [advanced][Optional]string $fieldtypes)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
Table |
integer(int32) (Table) |
The table in Business Central to retrieve data from |
True |
|
|
$contains |
string (Contains) |
A partial text value that the fieldname should contain |
False |
|
|
$fieldtypes |
string (Field Types) |
A pipe ( | ) separated list of filters used to retrieve only specific field types |
False |
Returns:
Type:array of (GetFieldsResponseItem)
Summary: Deletes a registration webhook from the Business Central environment
Description: Deletes a webhook,
Syntax:
Connect2All.DeleteTriggerV2 (string environment, string company, string Id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
environment |
string
|
|
True |
|
|
company |
string
|
|
True |
|
|
Id |
string
|
The id of the registered webhook |
True |
Returns:
Summary: Triggers when a record is created
Description: A record is created in Business Central
Syntax:
Connect2All.RecordCreated (string Environment, string Company, RecordCreatedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
body |
|
|
True |
Returns:
Summary: Triggers when a record is deleted
Description: A record is deleted in Business Central
Syntax:
Connect2All.RecordDeleted (string Environment, string Company, RecordDeletedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
body |
|
|
True |
Returns:
Summary: Triggers when a record is updated
Description: A record is updated in Business Central
Syntax:
Connect2All.RecordUpdated (string Environment, string Company, RecordUpdatedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
body |
|
|
True |
Returns:
Summary: Triggers when a record is created (V2)
Description: A record is created in Business Central
Syntax:
Connect2All.RecordCreatedV2 (string Environment, string Company, RecordCreatedV2ParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
body |
|
|
True |
Returns:
Summary: Triggers when a record is deleted (V2)
Description: A record is deleted in Business Central
Syntax:
Connect2All.RecordDeletedV2 (string Environment, string Company, RecordDeletedV2ParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
body |
|
|
True |
Returns:
Summary: Triggers when a record is updated (V2)
Description: A record is updated in Business Central
Syntax:
Connect2All.RecordUpdatedV2 (string Environment, string Company, RecordUpdatedV2ParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Environment |
string (Environment) |
The Business Central environment to connect to |
True |
|
|
Company |
string (Company) |
The Business Central company to connect to |
True |
|
|
body |
|
|
True |
Returns:
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
SystemId |
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
SystemId |
string
|
|
Summary: Request
Description: The request to insert data
Properties:
|
Name |
Type |
Summary |
|
fieldvalues |
array of (FieldvaluesItem) Field Values |
The fields with the values to set |
|
table |
integer(int32) Table |
The table from which you want to retrieve data |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Field |
A field from the selected table |
|
value |
string Value to set |
The value to set for this field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
id |
|
name |
string
|
name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary: Response
Description: Response
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary: Response
Description: Response
Properties:
|
Name |
Type |
Summary |
Summary: Response
Description: Response
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
default |
boolean
|
Default |
|
fieldtype |
string
|
Field Type |
|
id |
integer(int32)
|
Id |
|
isflowfield |
boolean
|
Is Flowfield |
|
keyposition |
integer(int32)
|
Key Position |
|
length |
integer(int32)
|
Length |
|
name |
string
|
Name |
|
options |
|
Options |
|
relatedfieldid |
integer(int32)
|
Related Field Id |
|
relatedtableid |
integer(int32)
|
Related Table Id |
Summary:
Description: Options
Properties:
|
Name |
Type |
Summary |
|
0 |
string
|
0 |
|
1 |
string
|
1 |
|
2 |
string
|
2 |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
name |
string
|
name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: The schema for this read request
Properties:
|
Name |
Type |
Summary |
|
schema |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: The schema for this read request
Properties:
|
Name |
Type |
Summary |
|
schema |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: The schema for this read request
Properties:
|
Name |
Type |
Summary |
|
schema |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: The schema for this webhook
Properties:
|
Name |
Type |
Summary |
|
schema |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
codeunitId |
integer(int32) Codeunit |
The codeunit you wish to execute |
|
parameters |
string Parameter String |
The parameter string to pass to the codeunit |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
string Csv Data |
The CSV data you wish to process |
|
delimiter |
string Delimiter |
The delimiter to be used to seperate the columns |
|
skipfooterlines |
integer Skip Footer Lines |
Set how many footer lines you wish to skip |
|
skipheaderlines |
integer Skip Header Lines |
Set how many header lines you wish to skip |
|
useheaders |
boolean Use Headers |
If set headers are used in the CSV |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
string
|
data |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary: Request
Description: The request to retrieve data
Properties:
|
Name |
Type |
Summary |
|
fields |
array of (integer(int32)) Select |
Select a field you want to retrieve |
|
filters |
array of (FiltersItem) Filterfields |
Field with filters that will be applied when retrieving data |
|
name |
string Name |
Your reference name for this table request object |
|
orderby |
array of (integer(int32)) Order by |
Data will be sorted using these fields |
|
sortorder |
string Sorting Order |
Whether the data returned is sorted in ascending or descending order Values: [Ascending, Descending] |
|
table |
integer(int32) Table |
The table from which you want to retrieve data |
|
top |
integer(int32) Top |
The maximum amount of records to return |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
field |
integer(int32) Field |
A field from the selected table |
|
filter |
string Filter |
A valid Business Central filter value |
Summary: Request
Description: The request to retrieve data
Properties:
|
Name |
Type |
Summary |
|
fields |
array of (integer(int32)) Select |
Select a field you want to retrieve |
|
table |
integer(int32) Table |
The table from which you want to retrieve data |
Summary: Request
Description: The request to retrieve data
Properties:
|
Name |
Type |
Summary |
|
fields |
array of (integer(int32)) Select |
Select a field you want to retrieve |
|
name |
string Name of request |
The name of the request |
|
table |
integer(int32) Table |
The table from which you want to retrieve data |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CallbackUrl |
string
|
CallbackUrl |
|
TableId |
integer(int32)
|
TableId |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CallbackUrl |
string
|
CallbackUrl |
|
Fields |
array of (integer(int32)) Select |
Select a field you want to retrieve |
|
Filters |
array of (FiltersItem) Filterfields |
Field with filters that will be applied when retrieving data |
|
TableId |
integer(int32)
|
TableId |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Field |
integer(int32) Field |
A field from the selected table |
|
FilterValue |
string Filter |
A valid Business Central filter value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CallbackUrl |
string
|
CallbackUrl |
|
TableId |
integer(int32)
|
TableId |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CallbackUrl |
string
|
CallbackUrl |
|
Fields |
array of (integer(int32)) Select |
Select a field you want to retrieve |
|
Filters |
array of (FiltersItem) Filterfields |
Field with filters that will be applied when retrieving data |
|
TableId |
integer(int32)
|
TableId |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Field |
integer(int32) Field |
A field from the selected table |
|
FilterValue |
string Filter |
A valid Business Central filter value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CallbackUrl |
string
|
CallbackUrl |
|
TableId |
integer(int32)
|
TableId |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CallbackUrl |
string
|
CallbackUrl |
|
Fields |
array of (integer(int32)) Select |
Select a field you want to retrieve |
|
Filters |
array of (FiltersItem) Filterfields |
Field with filters that will be applied when retrieving data |
|
TableId |
integer(int32)
|
TableId |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Field |
integer(int32) Field |
A field from the selected table |
|
FilterValue |
string Filter |
A valid Business Central filter value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary: Request
Description: The request to insert data
Properties:
|
Name |
Type |
Summary |
|
fieldvalues |
array of (FieldvaluesItem) Field Values |
The fields with the values to set |
|
systemId |
string System Id |
The id of the record in Business Central |
|
table |
integer(int32) Table |
The table from which you want to retrieve data |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Field |
A field from the selected table |
|
value |
string Value to set |
The value to set for this field |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fields |
array of (integer(int32))
|
|
|
tableId |
integer(int32) Table |
|