AristoTelos Academy

Period-based API Import Job Parameters

Period-based API Import Job Parameters

Jobs for importing data from an external API.

DynamicPeriod

Section

Defines the period for which data is imported.

Name of the import type used by the integration.

Typestring

External API URL.

Typestring

Use Cases

Period-based API Import Job for Import Time Range

Use Case

DynamicPeriod.Type, DynamicPeriod.Count and DynamicPeriod.Offset fields control the imported time range.

Import previous day data

Useful for regular daily imports.

{
"DynamicPeriod": {
"Type": "Day",
"Count": 1,
"Offset": -1
}
}

Import current day data

Useful for near real-time operational imports.

{
"DynamicPeriod": {
"Type": "Month",
"Count": 2,
"Offset": -1
}
}

Import previous and current month data

Useful for imports overlapping monthly periods or payroll closing periods.

{
"DynamicPeriod": {
"Type": "Month",
"Count": 2,
"Offset": -1
}
}

Was this helpful?