Exact Online Read

In this article

Overview

Exact Online is a Read-type Snap that reads and retrieves data objects from the Exact Online instance.

Prerequisites

A valid OAuth 2.0 account that supports Exact Online instance, with the appropriate access permissions. See Exact Online OAuth 2.0 Account.

Support for Ultra Pipelines  

Works in Ultra Pipelines

Limitations and Known Issues

None.

Snap Views

View Type

View Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

View Type

View Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper Snap

  • Copy Snap

  • JSON Parser

A document with data that indicates the entities to be filtered and retrieved from an Exact Online instance. 

Output

Document

  • Min: 1

  • Max: 1

  • Mapper Snap

  • Copy Snap

  • JSON Formatter

A document containing the entity data retrieved from an Exact Online instance.

Error

Document

  • Min: 1

  • Max: 1

N/A

The error view contains error, reason, resolution and stack trace. For more information, see Handling Errors with an Error Pipeline.

Snap Settings

Field Name

Field Type

Description

Field Name

Field Type

Description

Label*

String

Specify a unique name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.

Default Value: N/A
ExampleExact Online Read

Version*

Dropdown list

Choose or specify the version of the Exact Online API.

Default Value: v1
Example: v1

Division*

String/Expression/Suggestion

Specify a unique ID of the Exact Online Division (you can retrieve this ID using a REST call, https://start.exactonline.nl/api/v1/current/Me?). Alternatively, click the Suggestion  icon to fetch the list of supported divisions and select a division. 

Default Value: N/A
Example: 1234567

API object*

String/Expression/Suggestion

Specify the API that you want to access in the Exact Online instance. This dropdown list contains supported services available for the Exact Online instance. Alternatively, click the Suggestion  icon to fetch the list of API objects and select an object. 

Default Value: N/A
Example: CRM

Endpoint*

String/Expression/Suggestion

Specify an Exact Online Endpoint to be connected for each of the API objects.

Default Value: N/A
Example: Accounts

Filter records

Use this field set to define the filter criteria for the response result based on the specified parameters. Click to add a new row to define the filter criteria. You can enter only one filter criteria in each row. This field set comprises the following fields:

  • Field name

  • Operation

  • Field value

  • Condition

When you define multiple filters, the final output is generated based on the order that you have defined.

Field name

String

Specify the system parameter ($filter) field for filtering the records in the output.

Operation

String

Choose the comparison operator for the $filter field specified above from this drop-down list. Available options are: 

  • Equals

  • Not Equals

  • Greater than or Equal

  • Greater than

  • Less than or Equal

  • Less than

  • Starts with

  • Ends with

Field value

String

Specify the value with which the above $filter field must be compared. The data types: String, Integer, Boolean, or any other data type depends on the $filter field that you specified for the filter criterion.

Condition

String

Choose a value from this drop-down list to set the correlation between this filter criterion (row) and the next one (row), if being defined at all, to apply the filters for generating the final output. Available options are: 

  • Or: To retrieve records that match either the current criterion or the next criterion.

  • And: To retrieve only records that match both the current criterion and the next criterion.

  • None: To specify that the current and the next criteria can be evaluated independently of each other in retrieving the records.

Output field selection

This field set enables you to select the fields to include in the output. Click to add a new row to define the output field. You can enter only one output field in each row. 

To return all available fields in the output, do not specify any output fields.

 

String

Specify the fields from the result dataset to be populated in the output.

Default Value: N/A
Example: ID, name1, name2