Table of Contents
Connections
Commands
Connections
Trintech
Connector to the Trintech Cadency Rest API
Inputs
Input | Type | Detail | Notes |
Subscription Key | TextField | Trintech provides the key after your API subscription is set up, put that key here. | |
Username | TextField | The username of the user to perform operations on behalf of. | |
Password | TextField | The password for the user. |
Commands
Get Entities
Get a list of entities for a specified period
Inputs
Input | Type | Detail | Notes |
Period Id | TextField | The period ID of which to get a list of entities. If this is set the other fields will be ignored. | |
Year | TextField | The year in which to find entities | |
Period Name | TextField | The period in which to find entities |
Outputs
Output | Output Type | Notes |
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
Get information about a specific entity
Inputs
Input | Type | Detail | Notes |
Entity Id | TextField | The ID of the entity. If this is set other inputs will be ignored | |
Entity Name | TextField | The name of the entity to retrieve | |
Period Name | TextField | The period the entity is in | |
Year | TextField | The the year the period is in |
Outputs
Output | Output Type | Notes |
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
Get information about a specific entity definition
Inputs
Input | Type | Detail | Notes |
Entity Definition Id | TextField | The ID of the entity definition | |
Entity Definition Name | TextField | Optionally use the name instead of the ID |
Outputs
Output | Output Type | Notes |
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
Get a list of entity definitions
Inputs
None
Outputs
Output | Output Type | Notes |
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
Get a list of all fiscal years
Inputs
None
Outputs
Output | Output Type | Notes |
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
Get information about a specific task
Inputs
Input | Type | Detail | Notes |
Task Id | TextField | The ID of the task. If this is set the other inputs will be ignored. | |
Task Name | TextField | The name of the task | |
Year | TextField | The year of the period the task is in | |
Period Name | TextField | The year period for the task | |
Entity Name | TextField | The name of the entity the task is in |
Outputs
Output | Output Type | Notes |
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
Get information about a specific task definition
Inputs
Input | Type | Detail | Notes |
Task Definition Id | TextField | The ID of the task definition. If set other inputs will be ignored. | |
Entity Definition Name | TextField | The name of the entity definition the task definition is associated to | |
Task Definition Name | TextField | The name of the task definition |
Outputs
Output | Output Type | Notes |
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
Get a list of task definitions
Inputs
Input | Type | Detail | Notes |
Entity Definition Id | TextField | The ID of the associated entity definition | |
Entity Definition Name | TextField | The name of the associated entity |
Outputs
Output | Output Type | Notes |
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
Get a list of tasks for a specified entity
Inputs
Input | Type | Detail | Notes |
Entity Id | TextField | The entity ID of which to get a list of tasks. If this is set the other inputs will be ignored. | |
Entity Name | TextField | The name of the entity the task is in | |
Period Name | TextField | The year period for the task | |
Year | TextField | The year of the period the task is in |
Outputs
Output | Output Type | Notes |
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
Submit/Complete a Close Task
Inputs
Input | Type | Detail | Notes |
Task Id | TextField | The ID of the task. If this is set, all other inputs will be ignored to identify the task. | |
Task Name | TextField | The name of the task | |
Year | TextField | The year of the period the task is in | |
Period Name | TextField | The year period for the task | |
Entity Name | TextField | The name of the entity the task is in |
Outputs
Output | Output Type | Notes |
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 |