Integrations

patch

https://app.financekey.com/OData/Integrations({key})

An integration defines a connection to a 3rd party system.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

actionId

int32 | null

ActionId is the unique identifier for an action in the Integration table. Its data type is an integer. ActionId allows the user to seamlessly identify a specific action within the Integration table to locate and process the required information.

comment

string | null

Miscellaneous notes and information for the entry or record.

elementId

string | null

The ElementId field in the Integration table is an nvarchar that stores a unique identifier for each element that is integrated with the system. It has a maximum length of 256 characters.

entityId

string

required

length between 1 and 450

The internal Entity associated with the Integration. If Inbound, this is the destination Entity. If Outbound, this is the data source.

filter

string | null

A Linq expression that should be applied as a filter when identifying items to be added to the queue.

integrationDirectionId

string

required

length between 1 and 450

The direction of the integration

name

string

required

length between 1 and 128

Unique Name for the Integration

scheduleId

int32

The default schedule that should be applied to an enabled client integration.

systemDefnId

int32

The system into which the integration has been made.

maxAttemptCount

int32

The maximum number attempts that should be made in order to process an item on the Integration Queue.

includeUpdate

boolean

For outbound integrations, the default is to execute the integration once per row. However, when this box is ticked, the row will also be processed for entity updates. This flag can only be ticked for Integration that are active and outbound, and the continuous update is not ticked.

parallelExecution

boolean

When checked the actions on the integration queue will be executed in parallel.

consentTypeId

string

required

length between 1 and 64

Shows if a consent process should be intitiated when a client enables an integration, and the flow that should be followed. See Consent Type for more details.

batchSize

int32

The batch size is the maximum number of parallel items that will be processed from the queue for this integration.

managed

boolean

A amangeed integration is managed by FinanceKey, and is common to all clients. When an update is made to a managed integration, it is synchronised to all client tenants.

continuous

boolean

When continuous, the integration needs to be repeatedly executed, even if the row is not updated. An example of this is when the system needs to check for status updates from a remote application. Be sure to include an expiry in the filter. This flag can only be ticked for active outbound integrations where the Include Update flag is already ticked.

permitScheduleChange

boolean

When checked, the client is able to modify the schedule on the enabled client integration.

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!