To interact with tasks and entities within Trintech Cadency® as part of a chain, add a step with a Trintech Cadency connection command.
To enable these commands, an IT admin first creates a Trintech connector.
Get entities
To retrieve a list of entities for a specific period, use a Get entities command.
Properties
| Property | Detail |
|---|---|
| Period ID | Enter the unique identifier of the period to retrieve entities for. If provided, the command ignores the other inputs. |
| Year | Enter the year to retrieve entities for. If Period ID is provided, leave blank. |
| Period name | Enter the period to retrieve entities for. If Period ID is provided, leave blank. |
Outputs
| Output | Output type |
|---|---|
| Entities | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error executing command |
| 2 | Error | Failed to authenticate with the Trintech REST API |
Get entity
To retrieve information about an entity, use a Get entity command.
| Property | Detail |
|---|---|
| Entity ID | Enter the unique identifier of the entity to retrieve. If provided, the command ignores the other inputs. |
| Entity name | Enter the name of the entity to retrieve. If Entity ID is provided, leave blank. |
| Period name | Enter the period of the entity to retrieve. If Entity ID is provided, leave blank. |
| Year | Enter the year of the entity to retrieve. If Entity ID is provided, leave blank. |
Outputs
| Output | Output type |
|---|---|
| Entity | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error executing command |
| 2 | Error | Failed to authenticate with the Trintech REST API |
Get entity definition
To retrieve information about an entity definition, use a Get entity definition command.
| Property | Detail |
|---|---|
| Entity definition ID | Enter the unique identifier of the entity definition to retrieve. Alternatively, enter Entity definition name instead. |
| Entity definition name | Enter the name of the entity definition to retrieve. Alternatively, enter Entity definition ID input instead. |
Outputs
| Output | Output type |
|---|---|
| Entity definition | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error executing command |
| 2 | Error | Failed to authenticate with the Trintech REST API |
Get entity definitions
To retrieve a list of all entity definitions, use a Get entity dimensions command.
Properties
None
Outputs
| Output | Output type |
|---|---|
| Entity definitions | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error executing command |
| 2 | Error | Failed to authenticate with the Trintech REST API |
Get fiscal years
To retrieve a list of all fiscal years, use a Get fiscal years command.
Properties
None
Outputs
| Output | Output type |
|---|---|
| Fiscal years | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error executing command |
| 2 | Error | Failed to authenticate with the Trintech REST API |
Get task
To retrieve information about a task, use a Get task command.
| Property | Detail |
|---|---|
| Task ID | Enter the unique identifier of the task to retrieve. If provided, the command ignores the other inputs. |
| Task name | Enter the name of the task to retrieve. If Task ID is provided, leave blank. |
| Year | Enter the year of the task to retrieve. If Task ID is provided, leave blank. |
| Period name | Enter the name of the period of the task to retrieve. If Task ID is provided, leave blank. |
| Entity name | Enter the name of the entity to retrieve. If Task ID is provided, leave blank. |
Outputs
| Output | Output type |
|---|---|
| Task | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error executing command |
| 2 | Error | Failed to authenticate with the Trintech REST API |
Get task definition
To retrieve information about a task definition, use a Get task definition command.
| Property | Detail |
|---|---|
| Task definition ID | Enter the unique identifier of the task definition to retrieve. If provided, the command ignores the other inputs. |
| Entity definition name | Enter the name of the entity definition associated with the task definition to retrieve. If Task definition ID is provided, leave blank. |
| Task definition name | Enter the year of the task definition to retrieve. If Task definition ID is provided, leave blank. |
Outputs
| Output | Output type |
|---|---|
| Task definition | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error executing command |
| 2 | Error | Failed to authenticate with the Trintech REST API |
Get task definitions
To retrieve a list of task definitions associated with an entity definition, use a Get task definitions command.
| Property | Detail |
|---|---|
| Entity definition ID | Enter the unique identifier of the entity definition associated with the task definitions to retrieve. |
| Entity definition name | Enter the name of the entity definition associated with the task definitions to retrieve. |
Outputs
| Output | Output type |
|---|---|
| Task definitions | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error executing command |
| 2 | Error | Failed to authenticate with the Trintech REST API |
Get tasks
To retrieve a list of tasks for an entity, use a Get tasks command.
| Property | Detail |
|---|---|
| Entity ID | Enter the unique identifier of the entity associated with the tasks to retrieve. If provided, the command ignores the other inputs. |
| Entity name | Enter the name of the entity associated with the tasks to retrieve. If Entity ID is provided, leave blank. |
| Period name | Enter the name of the period of the tasks to retrieve. If Entity ID is provided, leave blank. |
| Year | Enter the year of the tasks to retrieve. If Entity ID is provided, leave blank. |
Outputs
| Output | Output type |
|---|---|
| Tasks | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error executing command |
| 2 | Error | Failed to authenticate with the Trintech REST API |
Submit task
To submit or complete a Close task, use a Submit task command.
| Property | Detail |
|---|---|
| Task ID | Enter the unique identifier of the task to submit. If provided, the command ignores the other inputs. |
| Task name | Enter the name of the task to submit. If Task ID is provided, leave blank. |
| Year | Enter the year of the task to submit. If Task ID is provided, leave blank. |
| Period name | Enter the name of the period of the task to submit. If Task ID is provided, leave blank. |
| Entity name | Enter the name of the entity associated with the task to submit. If Task ID is provided, leave blank. |
Outputs
| Output | Output type |
|---|---|
| Status | String |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error executing command |
| 2 | Error | Failed to authenticate with the Trintech REST API |